Move docs from gh-pages branch.

1 files changed, 30 insertions, 0 deletions

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 000000000..d1b4897d0
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,30 @@
+fixmystreet.org
+===============
+
+The gh-pages branch is [fixmystreet.org](https://fixmystreet.org), the
+Jekyll-based static site running on GitHub Pages that is the documentation for
+setting up / running the FixMyStreet platform.
+
+## Installation
+
+The site is built by Jekyll. We manage our Ruby gem dependencies via
+[bundler](https://bundler.io/) so you’ll need to install that if you don’t
+already have it. Then you need to…
+
+```
+git clone --recursive -b gh-pages https://github.com/mysociety/fixmystreet fixmystreet-pages
+cd fixmystreet-pages
+bundle install --deployment
+```
+
+To preview the site locally, run:
+
+```
+bundle exec jekyll serve --incremental
+```
+
+And then visit <http://127.0.0.1:4000>.
+
+Jekyll automatically compiles the HTML/Markdown and Sass files as you go.
+And [livereload](https://github.com/RobertDeRose/jekyll-livereload)
+automatically reloads your web browser window when the site is recompiled.