Index: README.md |
=================================================================== |
--- a/README.md |
+++ b/README.md |
@@ -8,24 +8,27 @@ make no stability guarantees whatsoever |
## How to use ## |
### Running the test server ### |
The test server will convert your content directory on the fly, your changes |
will become visible immediately. To run it you need: |
* Python 2.7 |
-* [Flask](http://flask.pocoo.org/), [Jinja2](http://jinja.pocoo.org/) and |
+* [Jinja2](http://jinja.pocoo.org/) and |
[Markdown](https://pypi.python.org/pypi/Markdown) modules (can be installed by |
- running `easy_install Flask Jinja2 Markdown` from the command line) |
+ running `easy_install Jinja2 Markdown` from the command line) |
* A current copy of the |
[cms repository](https://github.com/adblockplus/cms/) (can be |
[downloaded as ZIP file](https://github.com/adblockplus/cms/archive/master.zip) |
or cloned via `git clone https://github.com/adblockplus/cms.git`) |
+Optionally, the [Werkzeug](http://werkzeug.pocoo.org/) module can be installed |
+as well, this will provide some developer features. |
+ |
Run the `runserver.py` script from your content directory, e.g.: |
python ../cms/runserver.py |
Alternatively, the content directory could also be specified as command line |
parameter of `runserver.py`. This will start a local web server on port 5000, |
e.g. the page the page `pages/example.md` will be accessible under |
`http://localhost:5000/en/example`. |