]> rtime.felk.cvut.cz Git - coffee/main.git/commitdiff
README: Document how to use nix-shell for development master
authorMichal Sojka <michal.sojka@cvut.cz>
Wed, 1 Sep 2021 14:20:17 +0000 (16:20 +0200)
committerMichal Sojka <michal.sojka@cvut.cz>
Wed, 1 Sep 2021 14:20:17 +0000 (16:20 +0200)
README.md

index 718d2faf4dea1f0f5e48ae75e74b29ea0aa029d1..d12ed97c4c74bb1b4f960a00a0fe2db0ee33c83a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -39,6 +39,11 @@ First install all prerequisites:
     apt install python3-flask libev-dev cmake
        pip3 install flask_cors
 
+Alternatively, you can install [Nix package manager][] and run
+`nix-shell` in the `main` directory. This ensures that correct version
+of all needed dependencies are available in the shell (until you
+exit).
+
 Then compile and run all the software components:
 
 1. Compile _mtaio_ simulator: `make -C terminal/src/mt-apps SIM=1`
@@ -63,3 +68,4 @@ repository to configure git optimally for patch submission.
 [git send-email]: https://rtime.felk.cvut.cz/wiki/index.php/Configuring_git_send-email
 [mailing list]: https://rtime.felk.cvut.cz/mailman/listinfo/coffee
 [sg]: main.git/blob/HEAD:/setup_git
+[Nix package manager]: (https://nixos.org/guides/install-nix.html)