aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKatharina Fey <kookie@spacekookie.de>2020-01-06 22:18:22 +0000
committerKatharina Fey <kookie@spacekookie.de>2020-01-08 19:59:22 +0000
commitc12f3983f51f6c2f731394180e45fd8b41f5087a (patch)
tree6aa11f7f5740552c826b6b259f17f8c32498c491
parent7a224bb356b2d8f5a049915a14993ccfafddfc45 (diff)
Adding docs explaining how to use the nix build system
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index 47754d1..cad58e3 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,27 @@ Currently dev-suite has two tools:
#### Linux
- git
+#### With nix
+
+Optionally, if you're using on operating system that supports [nix],
+the functional package manager (Linux, MacOS), you can use the
+provided nix files to get all required dependencies.
+
+The provided setup uses [direnv] and [lorri] to automatically build
+the dependencies and provides them in your environment.
+
+[nix]: https://nixos.org/nix/
+[direnv]: https://direnv.net/
+[lorri]: https://github.com/target/lorri
+
+```
+$ direnv allow
+$ lorri daemon # this blocks by default
+```
+
+Then, whenever you change into the directory tree, your environment
+get's updated with the latest version that was built by the daemon.
+
#### Windows
- git for Windows installed to the default path for hooked to work