diff --git a/README.md b/README.md index 23c9049cb..1c1ff2113 100644 --- a/README.md +++ b/README.md @@ -84,9 +84,10 @@ invokes cmake commands as needed. #### On Linux and OS X * Install the dependencies -* Change to the root of the source code directory and build: +* Change to the root of the source code directory, change to the most recent release branch, and build: cd loki + git checkout master make *Optional*: If your machine has several cores and enough memory, enable @@ -96,6 +97,12 @@ invokes cmake commands as needed. *Note*: If cmake can not find zmq.hpp file on OS X, installing `zmq.hpp` from https://github.com/zeromq/cppzmq to `/usr/local/include` should fix that error. + + *Note*: The instructions above will compile the most stable release of the + Loki software. If you would like to use and test the most recent software, + use ```git checkout master```. The master branch may contain updates that are + both unstable and incompatible with release software, though testing is always + encouraged. * The resulting executables can be found in `build/release/bin` @@ -142,7 +149,7 @@ Tested on a Raspberry Pi Zero with a clean install of minimal Raspbian Stretch ( ``` git clone https://github.com/loki-project/loki.git cd loki - git checkout tags/v0.11.0.0 + git checkout master ``` * Build: ```