added README

1 files changed, 38 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..e49b5d7
--- /dev/null
+++ b/README
@@ -0,0 +1,38 @@
+== sublab web3
+
+Versuch einer mobile-first sublab website mit middleman (http://middlemanapp.com/)
+
+== Prerequisites
+
+* ruby
+* bundler ('gem install bundler')
+
+== Installation
+
+  git clone git+ssh://git@git.sublab.org/web3
+  cd web3
+  bundle
+
+== Developing
+
+  bundle exec middleman server
+  open http://localhost:4567
+
+  (edit files in the source/ directory, browser should autorefresh)
+
+== Building
+
+  bundle exec middleman build
+  open build/index.html
+
+== Problems / Features
+
+* No CSS yet
+* img/ is currently checked in source control because I'm lazy
+* Umlaute
+
+== Roadmap
+
+* implement a mobile-first grid using Bootstrap
+* write a sensible API server for the status box
+* add middleman blog extension and migrate old posts