README.md

README.md

@@ -5,8 +5,6 @@ Author: Marc Demierre <marc.demierre@gmail.com>
 
 License: Apache 2.0
 
-TODO: description
-
 
 Dependencies
 ------------
@@ -15,10 +13,18 @@ Dependencies
 * Perl (for indexing)
 * biber (for bibliography)
 
-TODO: details
+Make sure they are in your `PATH`.
 
 
 Getting started
 ---------------
 
-TODO
+* Install the dependencies
+* Fill your project details in `config/metadata.tex`
+* Build using the following commands:
+
+        pdflatex -shell-escape report
+        makeglossaries
+        biber report
+        pdflatex -shell-escape report
+        pdflatex -shell-escape report