Add installation instructions
[blenderbimorg.git] / README.md
1 # blenderbim.org
2
3 This website describes and provides support for using Blender for BIM.
4
5 The official website is hosted at https://blenderbim.org/
6
7 ## Contribute
8
9 I encourage everyone to help write content for the BlenderBIM.org website!
10
11 Get the code using `git clone git://sevenstrokes.net/blenderbimorg.git`
12
13 Please submit any patches to dion@thinkmoult.com. You can send it in patch
14 format, send a single modified file, or a link to your Git repository where I
15 can merge from.
16
17 ## Installation
18
19 BlenderBIM is designed to be a simple static website. It is coded in plain HTML
20 with Mustache as a templating language.
21
22  1. First, install [mo](https://github.com/tests-always-included/mo)
23  2. Set the baseurl of your web server at `config.sh`
24  3. Run `make pages`
25
26 That's it! The website will be built in the `www/` folder.