mirror of
https://gitlab.com/ahoneybun/nyxi-installer.git
synced 2025-05-12 19:14:03 -06:00
Work on docs for development and splitting the README up
This commit is contained in:
parent
784a9df0ca
commit
22a35cae0c
2 changed files with 48 additions and 29 deletions
40
README.md
40
README.md
|
@ -16,34 +16,16 @@ This sets the hashedPassword to my own so you will need to update it to match yo
|
||||||
mkpasswd -m sha-512
|
mkpasswd -m sha-512
|
||||||
```
|
```
|
||||||
|
|
||||||
|
# Usage
|
||||||
|
|
||||||
|
1. Boot from a live disk of NixOS (ideally the minimal image)
|
||||||
|
2. Connect to network
|
||||||
|
3. Download from the releases page using curl
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl $PATH
|
||||||
|
```
|
||||||
|
|
||||||
# Development
|
# 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.
|
|
||||||
|
|
37
docs/development.md
Normal file
37
docs/development.md
Normal file
|
@ -0,0 +1,37 @@
|
||||||
|
# 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
|
||||||
|
```
|
||||||
|
|
||||||
|
## For distros like Ubuntu install these packages
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo apt install build-essential pkg-config libcurl4-openssl-dev libfdisk-dev
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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.
|
Loading…
Add table
Add a link
Reference in a new issue