Skip to content

Commit 014b51c

Browse files
committed
docs: rewrite README for authenticity and clarity
- Replace marketing-heavy language with genuine, conversational tone - Emphasize real problems solved (two-hour setup ritual) over features - Simplify feature descriptions to be more human-friendly - Improve readability with shorter, punchier sentences - Update section headers to be more approachable (Why This Exists vs Why OpenBoot) - Streamline comparison table and preset descriptions
1 parent c1c155a commit 014b51c

1 file changed

Lines changed: 48 additions & 46 deletions

File tree

README.md

Lines changed: 48 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OpenBoot
22

3-
> The only Mac setup tool with a web dashboard and interactive TUI.
3+
> Setting up a new Mac shouldn't take two hours of your weekend.
44
>
55
> **[openboot.dev](https://openboot.dev)**
66
@@ -16,28 +16,28 @@
1616
<img src="demo.gif" alt="OpenBoot Demo" width="800" />
1717
</p>
1818

19-
**Without OpenBoot:**
19+
You know the drill. New Mac, same two-hour ritual:
2020

21-
```
21+
```bash
2222
brew install git node go python rust docker kubectl terraform
2323
brew install --cask visual-studio-code docker iterm2 chrome slack figma
2424
npm install -g typescript eslint prettier
25-
# ...copy .zshrc from old machine
26-
# ...configure git name/email
27-
# ...set macOS defaults
28-
# ...2 hours later, something is still missing
25+
# dig through old laptop for .zshrc
26+
# re-configure git identity
27+
# tweak macOS settings one by one
28+
# two hours later, still missing something
2929
```
3030

31-
**With OpenBoot:**
31+
Here's the alternative:
3232

3333
```bash
3434
brew install openbootdotdev/tap/openboot
3535
openboot
3636
```
3737

38-
Pick your tools in a TUI. Done in minutes. Or snapshot your current Mac and share it as a one-line install URL for your whole team.
38+
Pick what you need in a terminal UI. Takes minutes. Or snapshot your current Mac and share it—your whole team gets the same setup with one command.
3939

40-
Zero telemetry. Fully open source. MIT licensed.
40+
No tracking. No telemetry. Just works.
4141

4242
## Quick Start
4343

@@ -55,9 +55,11 @@ curl -fsSL openboot.dev/install.sh | bash
5555

5656
</details>
5757

58-
## Why OpenBoot
58+
## Why This Exists
59+
60+
Brewfiles are manual YAML editing. Nix has a brutal learning curve. Dotfile repos become unmaintainable after six months.
5961

60-
Other tools make you write YAML, learn Nix, or manage dotfile repos. OpenBoot gives you a visual TUI to pick packages, a web dashboard to manage configs, and shareable URLs so your whole team runs one command.
62+
I wanted something simple: a visual way to pick packages, a dashboard to manage configs without touching files, and URLs you can share. One command, same environment for everyone on your team.
6163

6264
| | OpenBoot | Brewfile | chezmoi | nix-darwin |
6365
|---|:---:|:---:|:---:|:---:|
@@ -69,69 +71,69 @@ Other tools make you write YAML, learn Nix, or manage dotfile repos. OpenBoot gi
6971

7072
## What It Does
7173

72-
- **Homebrew packages & GUI apps** — Docker, VS Code, Chrome, Warp, and more
73-
- **Dotfiles** — Clone your repo, deploy with GNU Stow, or skip
74-
- **Shell setup** — Oh-My-Zsh with sensible aliases
75-
- **macOS preferences** — Developer-friendly defaults (Dock, Finder, keyboard)
76-
- **Git identity**Configure name and email during setup
77-
- **Smart installs** — Detects already-installed tools, skips them
78-
- **Clean up** — Remove packages not in your config with `openboot clean`
79-
- **Full snapshot restore**Restores packages, git config, shell theme & plugins
74+
- **Homebrew packages & apps**Installs Docker, VS Code, Chrome, whatever you need
75+
- **Dotfiles** — Clone your repo and symlink with GNU Stow, or skip it
76+
- **Shell config**Sets up Oh-My-Zsh with useful aliases
77+
- **macOS settings** — Developer-friendly defaults for Dock, Finder, keyboard
78+
- **Git setup**Asks for your name and email, configures git
79+
- **Smart about duplicates** — Detects what's already installed, skips it
80+
- **Clean command** — Remove packages that drifted from your config
81+
- **Full restore**Snapshots save everything: packages, git config, shell theme, plugins
8082

8183
## Web Dashboard
8284

83-
[openboot.dev](https://openboot.dev)manage and share configs visually, no CLI required.
85+
[openboot.dev](https://openboot.dev)if you'd rather click than type commands.
8486

85-
- **Visual Config Builder**Create setups by clicking, not typing YAML
86-
- **Import from Brewfile**Drop your Brewfile, everything maps automatically
87-
- **Shareable URLs** — Every config gets a link: `openboot.dev/yourname/my-setup`
88-
- **Team Configs**One command to standardize your whole team's environment
87+
- **Visual builder**Pick packages with checkboxes instead of editing YAML
88+
- **Brewfile import**Already have a Brewfile? Drop it in, it maps automatically
89+
- **Shareable links** — Every config gets a URL: `openboot.dev/yourname/my-setup`
90+
- **Team configs**Share one link, everyone gets the same environment
8991

9092
## Presets
9193

92-
Start with a curated preset, customize in the TUI. [Compare presets](https://openboot.dev/docs/presets)
94+
Three starting points. Pick one, adjust in the TUI. [Full list](https://openboot.dev/docs/presets)
9395

94-
| Preset | Best For | Includes |
95-
|--------|----------|----------|
96-
| **minimal** | CLI essentials | ripgrep, fd, bat, fzf, lazygit, gh, Warp, Raycast, Rectangle |
97-
| **developer** | Full-stack devs | + Node, Go, Docker, VS Code, Chrome, OrbStack, TablePlus |
98-
| **full** | Power users | + Python, Rust, kubectl, Terraform, Ollama, Cursor, Figma |
96+
| Preset | What's In It |
97+
|--------|--------------|
98+
| **minimal** | CLI tools: ripgrep, fd, bat, fzf, lazygit, gh, Warp, Raycast, Rectangle |
99+
| **developer** | Minimal + Node, Go, Docker, VS Code, Chrome, OrbStack, TablePlus |
100+
| **full** | Developer + Python, Rust, kubectl, Terraform, Ollama, Cursor, Figma |
99101

100-
Not sure? Pick **developer** and toggle what you don't need.
102+
Most people start with **developer** and uncheck what they don't need.
101103

102104
## Snapshot
103105

104-
Already set up? Capture your environment and share it.
106+
Already have a Mac set up the way you like? Save it.
105107

106108
```bash
107109
openboot snapshot
108110
```
109111

110-
Captures Homebrew packages, macOS preferences, shell config (Oh-My-Zsh theme & plugins), and git settings. Upload to [openboot.dev](https://openboot.dev) for a shareable install URL, or save locally with `--local`.
112+
This captures everything: Homebrew packages, macOS settings, shell config, git identity. Upload it to [openboot.dev](https://openboot.dev) for a shareable URL, or save it locally with `--local`.
111113

112-
Restoring from a snapshot now fully restores your environment — packages, git identity, shell theme, and plugins. [Learn more](https://openboot.dev/docs/snapshot)
114+
When you restore a snapshot, you get everything back exactly as it was. [Docs](https://openboot.dev/docs/snapshot)
113115

114116
### Clean
115117

116-
Drifted from your config? Remove extra packages.
118+
Installed too much? Clean up what's not in your config.
117119

118120
```bash
119121
openboot clean # Compare against local snapshot
120122
openboot clean --user yourname # Compare against cloud config
121123
openboot clean --from my-setup.json # Compare against a snapshot file
122-
openboot clean --dry-run # Preview what would be removed
124+
openboot clean --dry-run # See what would be removed
123125
```
124126

125127
## For Teams
126128

127-
New developer joins → runs one command → ready to code. [Full guide](https://openboot.dev/docs/teams)
129+
New hire runs one command, gets the same environment as everyone else. [Guide](https://openboot.dev/docs/teams)
128130

129131
```bash
130132
brew install openbootdotdev/tap/openboot
131133
openboot --user yourteam/frontend
132134
```
133135

134-
Create configs on the [dashboard](https://openboot.dev/dashboard), share the install command in your onboarding docs. Stack changes? Update the config — the command stays the same.
136+
Make your config on the [dashboard](https://openboot.dev/dashboard), put this in your onboarding docs. When your stack changes, update the config. The install command stays the same.
135137

136138
## Advanced Usage
137139

@@ -204,14 +206,14 @@ openboot version # Print version
204206

205207
## FAQ
206208

207-
**Do I need anything installed first?**
208-
Just macOS 12.0+ and Homebrew. The one-line installer handles Homebrew for you if needed.
209+
**Do I need anything installed first?**
210+
macOS 12.0 or newer. Homebrew if you have it, but the installer will get it for you if not.
209211

210-
**What if I already have some tools?**
211-
OpenBoot detects them and skips reinstalling.
212+
**What if I already have some of these tools?**
213+
It checks what's installed and skips anything you already have.
212214

213-
**Is my data tracked?**
214-
No. Zero telemetry, zero analytics. Fully open source.
215+
**Is my data tracked?**
216+
No. No telemetry, no analytics. Code is open source, check for yourself.
215217

216218
---
217219

@@ -221,7 +223,7 @@ No. Zero telemetry, zero analytics. Fully open source.
221223

222224
## Contributing
223225

224-
Found a bug or want a feature? [Open an issue](https://github.com/openbootdotdev/openboot/issues) or submit a PR.
226+
Bug reports and feature requests: [open an issue](https://github.com/openbootdotdev/openboot/issues). Pull requests welcome.
225227

226228
<details>
227229
<summary><strong>Development Setup</strong></summary>

0 commit comments

Comments
 (0)