Updates to Readme.md

[biaweb2.git] / Readme.md

diff --git a/Readme.md b/Readme.md
index 68f6c94..acbbf15 100644 (file)
--- a/Readme.md
+++ b/Readme.md
@@ -39,3 +39,17 @@ template that can be further customized to suit your needs. The main philosophy
 of BiaWeb2 is to be as configuration-free as possible and hence most of the 
 customization for a specific website is within the templates themselves. The
 option `-q` is quiet-mode, to suppress the messages. 
+
+## Getting and compiling BiaWeb2 
+
+BiaWeb2 works on *nix-like operating systems. 
+
+To get BiaWeb2, clone the git repository (from the command line)
+
+    git clone https://gitlab.com/harishankarv/biaweb2.git
+
+To compile you require the following dependencies and a C++ compiler. Check your
+distribution package manager for more information
+
+* libmarkdown2 ([discount](https://www.pell.portland.or.us/~orc/Code/discount/))
+* libfmt ([fmt](https://github.com/fmtlib/fmt))