Added README.md
authorSybren A. Stüvel <sybren@stuvel.eu>
Thu, 20 Apr 2017 08:49:44 +0000 (10:49 +0200)
committerSybren A. Stüvel <sybren@stuvel.eu>
Thu, 20 Apr 2017 08:49:44 +0000 (10:49 +0200)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..6923d55
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+Blender Buildbot
+================
+
+This repo contains the theme, CSS, HTML and public configurations of Blender's
+[builder.blender.org](https://builder.blender.org/) web site.
+
+
+Running locally
+---------------
+
+- `sudo apt-get install buildbot` or `pip install buildbot<0.9`
+- `cp master_private_template.py master_private.py` and edit the file.
+- `git submodule init`
+- `git submodule update`
+
+
+Changing CSS stuff
+------------------
+
+- `sudo npm install -g grunt` -- this installs to `/usr/local/lib/node_modules` and
+  `/usr/local/bin`
+- `npm install` -- this installs to `./node_modules`
+
+After editing `public_html/assets/sass/main.sass`, run `grunt`.