mirror of
https://gitlab.com/ahoneybun/nyxi-installer.git
synced 2025-05-12 11:04:02 -06:00
First Rust rewrite release! 🎉
This commit is contained in:
parent
14b8ada912
commit
aebb38df61
9 changed files with 1389 additions and 15 deletions
47
docs/development.md
Normal file
47
docs/development.md
Normal file
|
@ -0,0 +1,47 @@
|
|||
# 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 or using the `nix` packagemanager 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
|
||||
```
|
||||
|
||||
## Flakes
|
||||
|
||||
If you have flakes enabled you can use `nix develop` instead.
|
||||
|
||||
```bash
|
||||
nix develop
|
||||
```
|
||||
|
||||
## Ubuntu
|
||||
|
||||
Install these packages for developing using `apt`.
|
||||
|
||||
```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