commit beb48937e03be8bd2392a7670b8f3fe56a252b0e
parent ec1b587f2f684718db9df8e1a6b2f19e04e92184
Author: Johann150 <20990607+Johann150@users.noreply.github.com>
Date: Fri, 19 Feb 2021 11:11:36 +0100
Merge pull request #38 from 06kellyjac/install_nix
add install notes for nix/NixOS
Diffstat:
2 files changed, 20 insertions(+), 6 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
* Have help exit with successfully with `0` rather than `1`
+* Split out install steps to allow for more options in the future
+* Add install notes for nix/NixOS
## [2.5.2] - 2021-02-12
diff --git a/README.md b/README.md
@@ -12,15 +12,27 @@ Since Agate by default uses port 1965, you should be able to run other servers (
* [Cargo package][crates.io]
* [Source code][source]
-## Installation and setup
+## Installation and Setup
-1. Download and unpack the [pre-compiled binary](https://github.com/mbrubeck/agate/releases).
+1. Get a binary for agate. You can use any of the below ways:
- Or, if you have the Rust toolchain installed, run `cargo install agate` to
- install agate from crates.io.
+### Pre-compiled
- Or download the source code and run `cargo build --release` inside the
- source repository, then find the binary at `target/release/agate`.
+Download and unpack the [pre-compiled binary](https://github.com/mbrubeck/agate/releases).
+
+### NixOS/Nix
+
+Using the nix package manager run `nix-env -i agate`
+
+_Note:_ agate is currently only in the unstable channel and will reach a release channel once the next release is tagged
+
+### Cargo
+
+If you have the Rust toolchain installed, run `cargo install agate` to install agate from crates.io.
+
+### Source
+
+Download the source code and run `cargo build --release` inside the source repository, then find the binary at `target/release/agate`.
***
You can use the install script in the `tools` directory for the remaining steps if there is one for your system.
