Mercurial > jouvence

comparison README.rst @ 6:486c2349598e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add README, LICENSE, and requirements files.
author Ludovic Chabant <ludovic@chabant.com>
date Tue, 03 Jan 2017 16:41:02 -0800
parents
children ee741bbe96a8
comparison
equal deleted inserted replaced
5:22f5f1374143 6:486c2349598e
1
2 ########
3 FONTAINE
4 ########
5
6
7 `Fountain`_ is a plain text markup language for screenwriting. Fontaine
8 is a Python package for parsing and rendering Fountain documents.
9
10 Fontaine supports:
11
12 * Most of the Fountain specification (see limitations below).
13 * Rendering to HTML and terminals.
14
15 .. _fountain: http://fountain.io/
16
17
18 Installation
19 ============
20
21 As with many Python packages, it's recommended that you use `virtualenv`_,
22 but since Fontaine doesn't have many dependencies, you should be fine.
23
24 You can install Fontaine the usual way::
25
26 pip install fontaine
27
28 If you want to test that it works, you can feed it a Fountain screenplay and
29 see if it prints it nicely in your terminal::
30
31 fontaine <path-to-fountain-file>
32
33 You should then see the Fountain file rendered with colored and indented
34 styles.
35
36 .. _virtualenv: https://virtualenv.pypa.io/en/stable/
37
38
39 Usage
40 =====
41
42 The Fontaine API goes pretty much like this::
43
44 from fontaine.parser import FontaineParser
45 from fontaine.html import HtmlDocumentRenderer
46
47 parser = FontaineParser()
48 document = parser.parse(path_to_file)
49 renderer = HtmlDocumentRenderer()
50 markup = renderer.render_doc(document)
51 return markup
52
53
54 Limitations
55 ===========
56
57 Fontaine doesn't support the complete Fountain syntax yet. The following things
58 are not implemented yet:
59
60 * Dual dialogue
61 * Notes
62 * Boneyards
63 * Sections and synopses
64
65