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.
23 lines
634 B
Markdown
23 lines
634 B
Markdown
# Installation
|
|
|
|
This project builds a single binary named `borg`.
|
|
|
|
Options to install:
|
|
|
|
- From source (requires Go 1.25 or newer):
|
|
- Clone the repository and build:
|
|
- `go build -o borg ./`
|
|
- Or use the Taskfile:
|
|
- `task build`
|
|
|
|
- From releases (recommended):
|
|
- Download an archive for your OS/ARCH from GitHub Releases once you publish with GoReleaser.
|
|
- Unpack and place `borg` on your PATH.
|
|
|
|
- Homebrew (if you publish to a tap):
|
|
- `brew tap Snider/homebrew-tap`
|
|
- `brew install borg`
|
|
|
|
Requirements:
|
|
- Go 1.25+ to build from source.
|
|
- macOS, Linux, Windows, or FreeBSD on amd64/arm64; Linux ARM v6/v7 supported.
|