2025-11-04 11:46:49 +00:00
|
|
|
# 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
|
|
|
|
|
|
2025-11-24 23:58:50 +00:00
|
|
|
- `go build ./...`
|
|
|
|
|
- `task build`
|
2025-11-04 11:46:49 +00:00
|
|
|
|
|
|
|
|
## Test
|
|
|
|
|
|
2025-11-24 23:58:50 +00:00
|
|
|
- `go test ./...`
|
|
|
|
|
- `task test`
|
2025-11-04 11:46:49 +00:00
|
|
|
|
2025-11-24 23:58:50 +00:00
|
|
|
Note: Some tests may require network or git tooling depending on environment (e.g., pushing to a temporary repo).
|
2025-11-04 11:46:49 +00:00
|
|
|
|
|
|
|
|
## Run
|
|
|
|
|
|
2025-11-24 23:58:50 +00:00
|
|
|
- `task run`
|
|
|
|
|
- `./borg --help`
|
2025-11-04 11:46:49 +00:00
|
|
|
|
|
|
|
|
## Docs
|
|
|
|
|
|
|
|
|
|
Serve the documentation locally with MkDocs:
|
|
|
|
|
|
2025-11-24 23:58:50 +00:00
|
|
|
- `pip install mkdocs-material`
|
|
|
|
|
- `mkdocs serve`
|
2025-11-04 11:46:49 +00:00
|
|
|
|
|
|
|
|
The site configuration lives in `mkdocs.yml` and content in `docs/`.
|