-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
5 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |