From c3aef2e0add183c1a7e3ef8353b6b6568778574c Mon Sep 17 00:00:00 2001 From: Awiteb Date: Fri, 18 Jul 2025 22:13:44 +0000 Subject: [PATCH] chore: Add `installation` section to `README.md` Signed-off-by: Awiteb --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index ae640bc..7c6617f 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,34 @@ into a future-proof foundation for decentralized collaboration. - - +## Installation + +You can install n34 either by cloning the repository and building it with Cargo, +or by using `cargo install`. + +### Building from source + +- Clone the repository: +```sh +git clone git://git.4rs.nl/awiteb/n34.git +cd n34 +``` + +- Build the release version: +```sh +cargo build --release +``` +The binary will be available at `target/release/n34`. + +### Using cargo install + +```sh +cargo install n34 +``` +The binary will be installed to your Cargo binary directory (typically `~/.cargo/bin/n34`). + +Make sure `~/.cargo/bin` is in your `PATH` environment variable to run the binary from anywhere. + ## Contributing Contributions to `n34` are welcome! You can help by opening issues (such as bug