From: Michal Sojka <michal.sojka@cvut.cz>
Date: Wed, 1 Sep 2021 14:20:17 +0000 (+0200)
Subject: README: Document how to use nix-shell for development
X-Git-Url: https://rtime.felk.cvut.cz/gitweb/coffee/main.git/commitdiff_plain/d242d03553ee096c3a87eb51e27e17991f746382

README: Document how to use nix-shell for development
---

diff --git a/README.md b/README.md
index 718d2fa..d12ed97 100644
--- 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)