From 0b6938e44cde14ed66e6b7af943d3176b5c559cd Mon Sep 17 00:00:00 2001
From: Yann Herklotz <git@yannherklotz.com>
Date: Fri, 1 Oct 2021 20:11:17 +0100
Subject: Update README with checkout instructions

---
 README.org | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

diff --git a/README.org b/README.org
index 09e2968..cf8bd34 100644
--- a/README.org
+++ b/README.org
@@ -42,23 +42,25 @@ compiled and executed. The dependencies of this project are the following:
 
 These dependencies can be installed manually, or automatically through Nix.
 
-*** Downloading CompCert
+*** Downloading Vericert and CompCert
     :PROPERTIES:
     :CUSTOM_ID: downloading-compcert
     :END:
 CompCert is added as a submodule in the =lib/CompCert= directory. It is needed to run the build
 process below, as it is the one dependency that is not downloaded by nix, and has to be downloaded
-together with the repository. To clone CompCert together with this project, you can run:
+together with the repository. To clone CompCert together with this project, and check it out at the
+correct revision, you can run:
 
 #+begin_src shell
-  git clone --recursive https://github.com/ymherklotz/vericert
+git clone -b v1.2.2 --recursive https://github.com/ymherklotz/vericert
 #+end_src
 
 If the repository is already cloned, you can run the following command to make sure that CompCert is
-also downloaded:
+also downloaded and the correct branch is checked out:
 
 #+begin_src shell
-  git submodule update --init
+git checkout v1.2.2
+git submodule update --init
 #+end_src
 
 *** Setting up Nix
@@ -71,7 +73,7 @@ reproducible. Once nix is installed, it can be used in the following way.
 To open a shell which includes all the necessary dependencies, one can use:
 
 #+begin_src shell
-  nix-shell
+nix-shell
 #+end_src
 
 which will open a shell that has all the dependencies loaded.
@@ -84,7 +86,7 @@ If the dependencies were installed manually, or if one is in the =nix-shell=, th
 by running:
 
 #+begin_src shell
-  make -j8
+make -j8
 #+end_src
 
 and installed locally, or under the =PREFIX= location using:
@@ -104,9 +106,9 @@ To test out =vericert= you can try the following examples which are in the test
 following:
 
 #+begin_src shell
-  ./bin/vericert test/loop.c -o loop.v
-  ./bin/vericert test/conditional.c -o conditional.v
-  ./bin/vericert test/add.c -o add.v
+./bin/vericert test/loop.c -o loop.v
+./bin/vericert test/conditional.c -o conditional.v
+./bin/vericert test/add.c -o add.v
 #+end_src
 
 ** Citation
-- 
cgit