Skip to content

Commit

Permalink
Update NixREADME.md
Browse files Browse the repository at this point in the history
  • Loading branch information
egurapha authored Feb 1, 2025
1 parent 81b2747 commit 6107fc4
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions nix/NixREADME.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
# Shunpo with Nix
A nix flake for Shunpo is provided at `nix/flake.nix`.
A nix flake for Shunpo is provided at `nix/flake.nix`. The nix flake can either be built for testing, or fully installed.

Building
---
You can test Shunpo by building the nix flake included in this directory (`Shunpo/nix/`).
1. Run `nix build .`, which will generate a folder called `result/`.
---
1. Within the `nix/` directory, run `nix build .` which will generate a folder called `result/`.
2. Intialize Shunpo by running `source result/bin/shunpo_init`.

Installation
---
To install Shunpo using the nix flake,
1. Run `nix install .#shunpo`.
1. Run `nix install .#shunpo` within the `nix/` directory.
2. Start a new terminal session and initialize Shunpo by running `source shunpo_init`.
3. If you would like to have Shunpo initialize by default, run the command below, which will append a line to your `.bashrc` to `source` the initialization file automatically.
3. If you would like to have Shunpo initialize automatically, run the command below, which will append a line to your `.bashrc` to `source` the initialization file.
```
echo "source shunpo_init" >> ~/.bashrc
```

0 comments on commit 6107fc4

Please sign in to comment.