Skip to content

Commit

Permalink
Add info about running a demo site. Refs #17.
Browse files Browse the repository at this point in the history
  • Loading branch information
koenedaele committed Apr 14, 2014
1 parent 022af5e commit b7780a2
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/source/demo.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
.. _running_the_demo:

Running a demo site
===================

Atramhasis comes with a demo site include. This allows you to quickly evaluate
and inspect the software. To get started, just download Atramhasis from pypi and
install it. We recommend doing this in a virtualenvironment.

.. code-block:: bash
$ mkvirtualenv atramhasis_demo
$ pip install atramhasis
Once Atramhasis is installed, you can call upon a pyramid scaffold to generate
the demo site.

.. code-block:: bash
$ pcreate -s atramhasis_demo atramhasis_demo
This creates a local demo package you can run with just a few more commands:

.. code-block:: bash
$ initialize_atramhasis_db development.ini
$ python setup.py develop
$ pserve development.ini
The Atramhasis demo instance is now running on your localhost at post 6543.
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Contents:
:maxdepth: 2

intro
demo
development
api
changes
Expand Down

0 comments on commit b7780a2

Please sign in to comment.