Nico Jensch commited on
Commit
47bbbcd
1 Parent(s): ba4c3b0

docs: add NixOS installation

Browse files
Files changed (1) hide show
  1. docs/installation.md +37 -0
docs/installation.md CHANGED
@@ -162,4 +162,41 @@ cd websurfx
162
  git checkout stable
163
  ```
164
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
165
  [⬅️ Go back to Home](./README.md)
 
162
  git checkout stable
163
  ```
164
 
165
+ ## NixOS
166
+
167
+ A flake.nix has been provided to allow installing `Websurfx` easily. It utilizes [nearsk](https://github.com/nix-community/naersk) to automatically generate a derivation based on `Cargo.toml` and `Cargo.lock`.
168
+
169
+ The flake has several outputs, which may be consumed:
170
+
171
+ ~~~bash
172
+ nix build .#websurfx
173
+ nix run .#websurfx
174
+ ~~~
175
+
176
+ You may include it in your own flake by adding this repo to its inputs and adding it to `environment.systemPackages`
177
+
178
+ ~~~nix
179
+ {
180
+ description = "My configuration";
181
+
182
+ inputs = {
183
+ websurfx.url = "github:neon-mmd/websurfx";
184
+ };
185
+
186
+ outputs = { nixpkgs, ... }@inputs: {
187
+ nixosConfigurations = {
188
+ hostname = nixpkgs.lib.nixosSystem {
189
+ system = "x86_64-linux";
190
+ modules = [{
191
+ environment.systemPackages = [
192
+ inputs.websurfx.websurfx
193
+ ];
194
+ }];
195
+ };
196
+ };
197
+ };
198
+ }
199
+
200
+ ~~~
201
+
202
  [⬅️ Go back to Home](./README.md)