Skip to content

Commit bbea2f0

Browse files
committed
docs: add star badge, why section, simplify CONTRIBUTING
1 parent 8fcd6b7 commit bbea2f0

2 files changed

Lines changed: 70 additions & 8 deletions

File tree

CONTRIBUTING.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Contributing
2+
3+
PRs welcome. This is a solo project, so I review everything personally.
4+
5+
## Quick Start
6+
7+
Fork, branch, code, test, PR:
8+
9+
```bash
10+
git clone https://github.com/YOUR_USERNAME/openboot.git
11+
cd openboot
12+
git checkout -b fix-something
13+
14+
# Make changes
15+
go build -o openboot ./cmd/openboot
16+
./openboot --dry-run
17+
18+
# Test
19+
make test-unit
20+
21+
# Commit
22+
git commit -m "fix: the thing"
23+
git push origin fix-something
24+
```
25+
26+
Then open a PR.
27+
28+
## Easy First Contributions
29+
30+
Just:
31+
- Add a package to `internal/config/data/packages.yaml`
32+
- Fix a typo
33+
- Improve an error message
34+
- Add a test
35+
36+
## Running Tests
37+
38+
```bash
39+
make test-unit # Fast
40+
make test-integration # Slower
41+
make test-all # Everything + coverage
42+
```
43+
44+
## Code Expectations
45+
46+
- Standard Go style (run `go vet`)
47+
- Add tests if you add features
48+
- Conventional commits (`feat:`, `fix:`, `docs:`)
49+
- One thing per commit
50+
51+
## Architecture
52+
53+
See [AGENTS.md](AGENTS.md) for how everything fits together.
54+
55+
## Questions
56+
57+
Open a [Discussion](https://github.com/openbootdotdev/openboot/discussions). I respond within 24 hours (usually faster).

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
> **[openboot.dev](https://openboot.dev)**
66
77
<p align="center">
8+
<a href="https://github.com/openbootdotdev/openboot/stargazers"><img src="https://img.shields.io/github/stars/openbootdotdev/openboot?style=social" alt="GitHub stars"></a>
89
<a href="https://github.com/openbootdotdev/openboot/releases"><img src="https://img.shields.io/github/v/release/openbootdotdev/openboot" alt="Release"></a>
910
<a href="LICENSE"><img src="https://img.shields.io/github/license/openbootdotdev/openboot" alt="License"></a>
1011
<a href="https://codecov.io/gh/openbootdotdev/openboot"><img src="https://codecov.io/gh/openbootdotdev/openboot/branch/main/graph/badge.svg" alt="codecov"></a>
@@ -39,6 +40,14 @@ Pick what you need in a terminal UI. Takes minutes. Or snapshot your current Mac
3940

4041
No tracking. No telemetry. Just works.
4142

43+
## Why OpenBoot?
44+
45+
**Fresh project, proven demand** — 2 weeks old, already trending on Reddit (100K+ views) and growing fast.
46+
47+
Brewfiles are manual YAML editing. Nix has a brutal learning curve. Shell scripts break silently. Dotfile repos become unmaintainable after six months.
48+
49+
OpenBoot is the first tool that handles **everything** — packages, dotfiles, shell config, macOS preferences, git identity — in an interactive TUI you can actually navigate. No config files to learn. No YAML to write. Just pick what you need and go.
50+
4251
## Quick Start
4352

4453
```bash
@@ -55,11 +64,7 @@ curl -fsSL openboot.dev/install.sh | bash
5564

5665
</details>
5766

58-
## Why This Exists
59-
60-
Brewfiles are manual YAML editing. Nix has a brutal learning curve. Dotfile repos become unmaintainable after six months.
61-
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.
67+
## How It Compares
6368

6469
| | OpenBoot | Brewfile | chezmoi | nix-darwin |
6570
|---|:---:|:---:|:---:|:---:|
@@ -206,13 +211,13 @@ openboot version # Print version
206211

207212
## FAQ
208213

209-
**Do I need anything installed first?**
214+
**Do I need anything installed first?**
210215
macOS 12.0 or newer. Homebrew if you have it, but the installer will get it for you if not.
211216

212-
**What if I already have some of these tools?**
217+
**What if I already have some of these tools?**
213218
It checks what's installed and skips anything you already have.
214219

215-
**Is my data tracked?**
220+
**Is my data tracked?**
216221
No. No telemetry, no analytics. Code is open source, check for yourself.
217222

218223
---

0 commit comments

Comments
 (0)