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

docs: clean up cmd readme, add just install hint

Browse Source
This commit is contained in:
mkelvers
2026-05-06 19:48:25 +02:00
parent 15cf2f4881
commit 901cf5497f
2 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -65,7 +65,7 @@ The codebase follows standard Go project layout conventions.
## Getting started ## Getting started
Requires Go `1.25+`, Bun, and a Playback proxy secret. Requires Go `1.25+`, Bun, and [just](https://github.com/casey/just) (`brew install just`).
```bash ```bash
git clone https://github.com/mkelvers/mal.git && cd mal git clone https://github.com/mkelvers/mal.git && cd mal

11
cmd/README.md
View File

@@ -1,9 +1,8 @@
# cmd # cmd
Executable entrypoints live here. Executables live here.
- `cmd/server`: main web process (`go run ./cmd/server`) | binary | purpose |
| --- | --- |
## Why this structure | `cmd/server` | web server |
| `cmd/user` | user creation CLI |
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.