Mercurial > jouvence
diff README.rst @ 13:ee741bbe96a8
Rename to 'Jouvence'.
author | Ludovic Chabant <ludovic@chabant.com> |
---|---|
date | Wed, 04 Jan 2017 09:02:29 -0800 |
parents | 486c2349598e |
children | f21776c7fbfc |
line wrap: on
line diff
--- a/README.rst Wed Jan 04 08:51:32 2017 -0800 +++ b/README.rst Wed Jan 04 09:02:29 2017 -0800 @@ -1,13 +1,13 @@ ######## -FONTAINE +JOUVENCE ######## -`Fountain`_ is a plain text markup language for screenwriting. Fontaine +`Fountain`_ is a plain text markup language for screenwriting. Jouvence is a Python package for parsing and rendering Fountain documents. -Fontaine supports: +Jouvence supports: * Most of the Fountain specification (see limitations below). * Rendering to HTML and terminals. @@ -19,16 +19,16 @@ ============ As with many Python packages, it's recommended that you use `virtualenv`_, -but since Fontaine doesn't have many dependencies, you should be fine. +but since Jouvence doesn't have many dependencies, you should be fine. -You can install Fontaine the usual way:: +You can install Jouvence the usual way:: - pip install fontaine + pip install jouvence If you want to test that it works, you can feed it a Fountain screenplay and see if it prints it nicely in your terminal:: - fontaine <path-to-fountain-file> + jouvence <path-to-fountain-file> You should then see the Fountain file rendered with colored and indented styles. @@ -39,12 +39,12 @@ Usage ===== -The Fontaine API goes pretty much like this:: +The Jouvence API goes pretty much like this:: - from fontaine.parser import FontaineParser - from fontaine.html import HtmlDocumentRenderer + from jouvence.parser import JouvenceParser + from jouvence.html import HtmlDocumentRenderer - parser = FontaineParser() + parser = JouvenceParser() document = parser.parse(path_to_file) renderer = HtmlDocumentRenderer() markup = renderer.render_doc(document) @@ -54,7 +54,7 @@ Limitations =========== -Fontaine doesn't support the complete Fountain syntax yet. The following things +Jouvence doesn't support the complete Fountain syntax yet. The following things are not implemented yet: * Dual dialogue