commit f28117a326cc07f99f8f51c92a91079c45a4c91f
parent d8fb293fa1cdd3b4f10c940786628d97a45b48e6
Author: Antoine Amarilli <a3nm@a3nm.net>
Date: Thu, 18 Apr 2019 16:48:53 +0200
getting started guide
credit: Tesla
<aef5fd8a-ae65-e7eb-434f-5e6b060d4a6f@tesla.wf>
Diffstat:
| README | | | 76 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-------- |
1 file changed, 68 insertions(+), 8 deletions(-)
diff --git a/README b/README
@@ -30,23 +30,83 @@ It depends on haspirater <https://a3nm.net/git/haspirater> and frhyme
The full documentation of plint's features is available in views/about.html.
-== 2. Setup ==
+== 2. Getting started ==
-First, make sure that you have a working python3 installation and that you have
-unzip (Debian packages: python3, unzip).
+This section provides a quick summary of how to get started with setting up and
+using plint. If these instructions do not work for you, please let me know.
-Place haspirater.py and haspirater.json from haspirater in the main directory.
-Place frhyme.py and frhyme.json from frhyme in the main directory (see frhyme's
-README for instructions on how to generate frhyme.json). Generate the
-occurrences file as follows:
+0. Basic setup
+
+Make sure that you have a working python3 installation and that you have unzip
+(Debian packages: python3, unzip).
+
+1. Clone the plint repository
+
+If you haven't done so already:
+
+ git clone https://a3nm.net/git/plint/
+ cd plint
+
+2. Retrieve the dependencies
+
+In the directory where plint has been cloned, run:
+
+ git clone https://a3nm.net/git/haspirater/
+ git clone https://a3nm.net/git/frhyme/
+
+3. Generate frhyme.json
+
+Run:
+
+ cd frhyme
+ lexique/lexique_retrieve.sh > lexique.txt
+ ./make.sh 4 lexique.txt additions > frhyme.json
+ cd ..
+
+4. Link the missing files
+
+Run:
+
+ ln -s frhyme/frhyme.py
+ ln -s frhyme/frhyme.json
+ ln -s haspirater/haspirater.py
+ ln -s haspirater/haspirater.json
+
+5. Generate the occurrences file
+
+Run:
./lexique_occurrences_retrieve.sh > occurrences
+6. Locales
+
For locale support, install gettext (Debian package: gettext) and run:
make
-== 3. Usage ==
+7. Running plint
+
+If you want to check a poem that consists of classical alexandrines with flat
+rhyme (like the file test/mithridate), write the contents of the poem to check
+into a file poem.txt. Then run:
+
+ ./plint.py test/mithridate.tpl < poem.txt
+
+Plint will display the errors (if any) and exit.
+
+8. Customizing the template
+
+If you want to customize the template of the poem, you can look at examples on
+the online tool (https://plint.a3nm.net/fr/) or files ending in ".tpl" in the
+source repository. You can then write your template into a file called
+template.tpl and run:
+
+ ./plint.py template.tpl < poem.txt
+
+The file format for templates is tersely documented on
+https://plint.a3nm.net/en/about#template
+
+== 3. Detailed usage ==
To use the program's command-line interface, run:
