Skip to content

Commit

Permalink
Added a section for getting started to the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
blixt committed Jul 21, 2010
1 parent b043625 commit 495664d
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Expand Up @@ -4,6 +4,22 @@ Storyteller is a web app for collaboratively writing stories being developed in

If you want to contribute, please see [the wave discussing future development of Storyteller](https://wave.google.com/wave/waveref/googlewave.com/w+soBIcBHBA). For access, contact Andreas Blixt (andreas@blixt.org).

## Getting started

How to get a newly cloned version up and running in a local development environment.

### Prerequisites

1. [Python 2.5](http://www.python.org/download/releases/2.5/)
2. [Google App Engine SDK for Python](http://code.google.com/appengine/downloads.html)
3. [Django 1.1](http://www.djangoproject.com/download/)

### Configuration

1. Copy `src/app.yaml.template` to `src/app.yaml` and change the application identifier (`example` by default)
2. Copy `src/storyteller/settings.py.template` to `src/storyteller/settings.py` and change the configuration as desired
3. Run the application on the development server

## API

The Storyteller application does everything through a controller which communicates with the data layer. All the public methods of the controller are accessible using HTTP requests. Examples:
Expand Down

0 comments on commit 495664d

Please sign in to comment.