diff options
Diffstat (limited to 'README.markdown')
| -rw-r--r-- | README.markdown | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown index 01c814b..db5a2f5 100644 --- a/README.markdown +++ b/README.markdown @@ -33,6 +33,15 @@ the master branch may not always work. I'm currently working on supporting the whole [Fountain](http://fountain.io) specification. (Fountain was previously known as "Screenplay Markdown" or "SPMD.") +Installing +========== + + pip install screenplain + +To enable PDF output, install with the PDF extra (installs ReportLab): + + pip install 'screenplain[PDF]' + Credits ======= @@ -60,8 +69,18 @@ Set up environment using virtualenvwrapper: mkvirtualenv --no-site-packages screenplain pip install -r requirements.txt +<<<<<<< HEAD For developing for Python 3, instead use: mkvirtualenv --no-site-packages --python=$(which python3) screenplain-py3 pip install -r requirements-py3.txt +======= + pip install -e . + +After this, the `screenplain` command will use the working copy of your code. + +To run unit tests and style checks, run: + + bin/test +>>>>>>> master |