diff --git a/README.md b/README.md index 0b9f3d2..04c0632 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,6 @@ This installer is named after my doggo Onyxia. -## Starting the Installer - -```bash -``` - At the core of this installer it does the following: - Partition the drive of your choice using the `rsfdisk` crate. @@ -20,3 +15,35 @@ This sets the hashedPassword to my own so you will need to update it to match yo ```bash mkpasswd -m sha-512 ``` + +# Development + +## Clone the repository + +```bash +git clone https://gitlab.com/ahoneybun/nyxi-installer.git +``` + +## Enter the repository that you just cloned + +```bash +cd nyxi-installer +``` + +## Enter nix-shell + +This is if you are already running NixOS on your system where development will take place. This will install the needed system packages, set environment variables and such for development. + +```bash +nix-shell +``` + +## Building and testing + +You can use normal `cargo` commands like: + +- `cargo test` +- `cargo build` +- `cargo run` + +**NOTE:** you will need to build the program and run it with `sudo` currently so `cargo run` is not the best for testing.