Skip to content

Commit c17cdea

Browse files
brainrakeaciceri
authored andcommitted
add doc setup section
1 parent 1be1e0e commit c17cdea

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

docs/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ nav:
6262
- Getting Started:
6363
- Overview: getting-started/overview.md
6464
- Usage:
65+
- Setup: usage/setup.md
6566
- Configure pool: usage/configure-pool.md
6667
- Generating keys: usage/generate-keys.md
6768
- Deploy: usage/deploy.md

docs/usage/setup.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Installation
2+
3+
Follow [this guide](https://zero-to-nix.com/start/install) to Install nix with [flakes](https://nix.dev/concepts/flakes.html) enabled.
4+
5+
### Binary cache
6+
7+
You can optionally use this project's binary cache to skip building software and download it instead. Edit `/etc/nix/nix.conf` (or related settings in NixOS config) and merge the new values separated by spaces into the options:
8+
9+
```
10+
substituters = ... https://cache.staging.mlabs.city/spo-anywhere
11+
trusted-public-keys = ... spo-anywhere:bmI58BmXnmeuAtMKbm3qhwiJ1RALMfo6cDwncfaGa6Q=
12+
```
13+
14+
## Start new project from flake
15+
16+
Create a new directory, enter it, and initialize a new project form the spo-anywhere flake template.
17+
18+
```
19+
mkdir my-spo
20+
cd my-spo
21+
nix flake init --template github:mlabs-haskell/spo-anywhere
22+
```
23+
24+
Check that the installation script starts:
25+
26+
```
27+
nix run .#install -- -h
28+
```

0 commit comments

Comments
 (0)