melosh/mal
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: reword cmd README to match main README prose

Browse Source
This commit is contained in:
mkelvers
2026-04-20 01:16:03 +02:00
parent 6fe78963c8
commit 158ead08f3
1 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
cmd/README.md
View File

@@ -1,11 +1,9 @@
# cmd layout
# cmd
This repository keeps executable entrypoints under `cmd/`.
Executable entrypoints live here.
- `cmd/server`: main web process (`go run ./cmd/server`)
Why this exists:
## Why this structure
- Keeps the repository root focused on project metadata (`README.md`, `go.mod`, `Dockerfile`, etc)
- Scales cleanly if more binaries are added later (for example: `cmd/migrate`, `cmd/admin`, `cmd/worker`)
- Matches common Go repository conventions for multi-binary or growing services
I wanted to keep the repository root clean and focused on project metadata like `README.md`, `go.mod`, and `Dockerfile`. Keeping entrypoints under `cmd/` also makes it easy to add more binaries later without cluttering the root, and it matches standard Go conventions for projects that grow beyond a single binary.