Skip to content

Commit

Permalink
Update installation docs (#17)
Browse files Browse the repository at this point in the history
[skip-ci]
  • Loading branch information
ssanj authored Apr 14, 2024
1 parent 953436c commit e564cbb
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "zat"
version = "0.11.12"
version = "0.11.13"
edition = "2021"
authors = ["Sanj Sahayam"]

Expand Down
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,14 @@ zat bootstrap --repository-dir <ZAT_REPOSITORY>

### Downloading a Release

Download the latest [release](https://github.com/ssanj/zat/releases) for your operating system (linux or macos).
Download the latest [release](https://github.com/ssanj/zat/releases) for your operating system (Linux or macOSX).
Make it executable with:

`chmod +x <ZAT_EXEC>`

Copy executable to a directory on your path.

Note: Windows is not explicitly supported at this time as I don't use Windows myself. If you install Zat on Windows and have any problems please raise an issue.
Note: Windows is not explicitly supported at this time as I don't use Windows myself. If you want Windows support and can help with the implementation and testing, get in touch.


### Building through Cargo
Expand All @@ -78,5 +78,16 @@ cargo build --release
Copy binary file from target/release/zat to a directory on your PATH.
```

See the [User Manual](docs/user-manual/user-manual.md) for more information.
### Using Homebrew

You can use [Homebrew](https://brew.sh/) to install Zat from source on macOSX and Linux:

```
brew tap ssanj/homebrew-zat
brew install zat
```

See [Taps](https://docs.brew.sh/Taps) for more information on taps.

Continue onto the [User Manual](docs/user-manual/user-manual.md) for more detailed information on Zat.

0 comments on commit e564cbb

Please sign in to comment.