629a6e6464
- Update docs/cli.md to include all current commands (all, compile, run, decode) and correct terminology (TIM). - Update docs/library.md with correct, runnable Go code examples and updated import paths. - Update docs/development.md, docs/installation.md, and docs/releasing.md to reflect the project's Go version (1.25.0). - Remove outdated "No functional changes" notes from documentation files.
687 B
687 B
Development
Prerequisites:
- Go 1.25 or newer
- Task (optional) — https://taskfile.dev
- MkDocs Material (optional for docs) —
pip install mkdocs-material
Workspace
This repo includes a go.work file configured for Go 1.25 to align with common workflows.
Build
go build ./...task build
Test
go test ./...task test
Note: Some tests may require network or git tooling depending on environment (e.g., pushing to a temporary repo).
Run
task run./borg --help
Docs
Serve the documentation locally with MkDocs:
pip install mkdocs-materialmkdocs serve
The site configuration lives in mkdocs.yml and content in docs/.