Add installation instructions
authorDion Moult <dion@thinkmoult.com>
Mon, 6 Jan 2020 10:45:39 +0000 (21:45 +1100)
committerDion Moult <dion@thinkmoult.com>
Mon, 6 Jan 2020 10:45:39 +0000 (21:45 +1100)
README.md

index 25e568503ea5a22d9091cd62342a00e7ea57d54d..056af12985564702c517f0406de0b947b2470821 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,8 +6,21 @@ The official website is hosted at https://blenderbim.org/
 
 ## Contribute
 
+I encourage everyone to help write content for the BlenderBIM.org website!
+
 Get the code using `git clone git://sevenstrokes.net/blenderbimorg.git`
 
 Please submit any patches to dion@thinkmoult.com. You can send it in patch
 format, send a single modified file, or a link to your Git repository where I
 can merge from.
+
+## Installation
+
+BlenderBIM is designed to be a simple static website. It is coded in plain HTML
+with Mustache as a templating language.
+
+ 1. First, install [mo](https://github.com/tests-always-included/mo)
+ 2. Set the baseurl of your web server at `config.sh`
+ 3. Run `make pages`
+
+That's it! The website will be built in the `www/` folder.