summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatt Jia <mjia@redhat.com>2014-03-19 12:42:36 +1000
committerMatt Jia <mjia@redhat.com>2014-03-19 17:04:10 +1000
commit4c4abd344849a7205830f81bfc6f9c75f8b0877e (patch)
treeb4c34dc5290930c845ce9ebc7f6bc632eed3697a
parent55ecfb1ea9cd9baae6eb46c5f292d1514e4a0987 (diff)
update the developer guide
-rw-r--r--README1
-rw-r--r--dev/guide/getting-started.rst6
2 files changed, 6 insertions, 1 deletions
diff --git a/README b/README
index 91bea4f..0260a50 100644
--- a/README
+++ b/README
@@ -42,6 +42,7 @@ Dependencies
* python-sphinx
* pandoc
* python-dulwich (to generate release changelogs)
+* rubygem-rdiscount ( to install markdown for shocco)
Building docs from a local checkout
-----------------------------------
diff --git a/dev/guide/getting-started.rst b/dev/guide/getting-started.rst
index 054c1e4..90e63b4 100644
--- a/dev/guide/getting-started.rst
+++ b/dev/guide/getting-started.rst
@@ -39,6 +39,10 @@ repository <http://git.beaker-project.org/cgit/beaker/>`_::
git clone git://git.beaker-project.org/beaker
+Update git submodules to keep track of all (recent) JS libraries::
+
+ git submodule update --init
+
For the purposes of development, Beaker should be run on the ``develop``
branch::
@@ -96,7 +100,7 @@ You can then start a development server using the ``start-server.py``
script, with ``PYTHONPATH`` adjusted for the git checkout::
cd Server/
- PYTHONPATH=../Common:. ./start-server.py
+ ./run-server.sh
The Beaker team uses `RHEL
6 <http://www.redhat.com/products/enterprise-linux/server/>`_ for