From c12f3983f51f6c2f731394180e45fd8b41f5087a Mon Sep 17 00:00:00 2001 From: Katharina Fey Date: Mon, 6 Jan 2020 22:18:22 +0000 Subject: Adding docs explaining how to use the nix build system --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) 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 -- cgit v1.2.3