commit f1aaa6156f5c635387519d4104be1f08bce863da
parent 5630784d0f5148e11102fcefd118b122434b6b9b
Author: Antoine Amarilli <a3nm@a3nm.net>
Date: Sat, 17 Aug 2019 18:57:24 +0200
update the README to the packaging etc.
Diffstat:
| README | | | 31 | ++++++++++++------------------- |
| SOURCES | | | 52 | ++++++++++++++++++++++++++++++---------------------- |
2 files changed, 42 insertions(+), 41 deletions(-)
diff --git a/README b/README
@@ -1,9 +1,11 @@
plint -- a French poetry validator
-Copyright (C) 2011-2019 by Antoine Amarilli
Repository URL: https://gitlab.com/a3nm/plint
+Online version: https://plint.a3nm.net/
Python package name: plint
-== 0. Licence ==
+== 0. Author and licence ==
+
+plint is copyright (C) 2011-2019 by Antoine Amarilli
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
@@ -16,11 +18,11 @@ PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with
this program (see file "COPYING"). If not, see <http://www.gnu.org/licenses/>.
-bottle.py is a third-party file, its license is in file LICENSE_bottle.
+The files in plint/test_data are public domain works used to test and train
+plint. Their sources are given in the file "SOURCES".
-test/boileau and test/andromaque are from Wikisource and test/baudelaire and
-test/mithridate are from Project Gutenberg. Both of them are in the public
-domain.
+Many thanks to Julien Romero for contributing to the code and for maintaining
+the PyPI package for plint and its dependencies.
== 1. Features ==
@@ -61,28 +63,19 @@ In the directory where plint has been cloned, run:
git clone https://gitlab.com/a3nm/frhyme.git
git clone https://gitlab.com/a3nm/haspirater.git
-3. Generate frhyme.json
-
-Run:
-
- cd frhyme
- lexique/lexique_retrieve.sh > lexique.txt
- ./make.sh 4 lexique.txt additions > frhyme.json
- cd ..
-
-4. Generate the occurrences file
+3. Generate the occurrences file
Run:
./lexique_occurrences_retrieve.sh > data/occurrences
-5. Locales
+4. Locales
For locale support, install gettext (Debian package: gettext) and run:
make
-6. Running plint
+5. 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
@@ -92,7 +85,7 @@ into a file poem.txt. Then run:
Plint will display the errors (if any) and exit.
-7. Customizing the template
+6. 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
diff --git a/SOURCES b/SOURCES
@@ -1,24 +1,32 @@
-All files on dramacode.github.io are originally from http://theatre-classique.fr by Paul Fièvre
+This file explains the origins of the files given in plint/test_data. To my
+knowledge, all of the corresponding works are in the public domain.
-All files on Wikisource are the work of many individual contributors
+boileau: Wikisource
+andromaque: Wikisource
+baudelaire: Project Gutenberg
+mithridate: Project Gutenberg
+racine_la_thebaide: https://fr.wikisource.org/wiki/La_Th%C3%A9ba%C3%AFde_ou_les_Fr%C3%A8res_ennemis/Didot
+racine_alexandre_le_grand: https://fr.wikisource.org/wiki/Alexandre_le_Grand/%C3%A9dition_Didot
+racine_les_plaideurs: https://fr.wikisource.org/wiki/Les_Plaideurs_(%C3%A9ditions_Didot,_1854)
+racine_britannicus: https://fr.wikisource.org/wiki/Britannicus_(%C3%A9ditions_Didot,_1854)
+racine_berenice: https://fr.wikisource.org/wiki/B%C3%A9r%C3%A9nice_(%C3%A9ditions_Didot,_1854)
+racine_bajazet: https://fr.wikisource.org/wiki/Bajazet_(%C3%A9ditions_Didot,_1854)
+racine_iphigenie: https://fr.wikisource.org/wiki/Iphig%C3%A9nie_en_Aulide_(Racine),_Didot,_1854
+racine_phedre: https://fr.wikisource.org/wiki/Ph%C3%A8dre_(Racine),_Didot,_1854
+racine_esther: https://fr.wikisource.org/wiki/Esther_(Racine),_Didot,_1854
+racine_athalie: https://fr.wikisource.org/wiki/Athalie_(Racine),_Didot,_1854
+corneille_place_royale: https://dramacode.github.io/naked/corneillep_placeroyale.txt
+corneille_suivante: https://fr.wikisource.org/wiki/La_Suivante
+corneille_galerie_du_palais: https://fr.wikisource.org/wiki/La_Galerie_du_Palais
+corneille_veuve: https://fr.wikisource.org/wiki/La_Veuve_(Corneille)
+corneille_clitandre: https://fr.wikisource.org/wiki/Clitandre
+corneille_melite: https://fr.wikisource.org/wiki/M%C3%A9lite/Texte_entier
+corneille_medee: https://dramacode.github.io/naked/corneillep_medee.txt
+corneille_oedipe: https://dramacode.github.io/naked/corneillep_oedipe.txt
+corneille_pertharite: https://dramacode.github.io/naked/corneillep_pertharite.txt
+corneille_illusion_comique: https://fr.wikisource.org/wiki/L%E2%80%99Illusion_comique_(%C3%A9dition_Didot,_1855)
+
+Note that all files on dramacode.github.io are originally from http://theatre-classique.fr by Paul Fièvre
+
+Note that all files on Wikisource are the work of many individual contributors
-racine_la_thebaide https://fr.wikisource.org/wiki/La_Th%C3%A9ba%C3%AFde_ou_les_Fr%C3%A8res_ennemis/Didot
-racine_alexandre_le_grand https://fr.wikisource.org/wiki/Alexandre_le_Grand/%C3%A9dition_Didot
-racine_les_plaideurs https://fr.wikisource.org/wiki/Les_Plaideurs_(%C3%A9ditions_Didot,_1854)
-racine_britannicus https://fr.wikisource.org/wiki/Britannicus_(%C3%A9ditions_Didot,_1854)
-racine_berenice https://fr.wikisource.org/wiki/B%C3%A9r%C3%A9nice_(%C3%A9ditions_Didot,_1854)
-racine_bajazet https://fr.wikisource.org/wiki/Bajazet_(%C3%A9ditions_Didot,_1854)
-racine_iphigenie https://fr.wikisource.org/wiki/Iphig%C3%A9nie_en_Aulide_(Racine),_Didot,_1854
-racine_phedre https://fr.wikisource.org/wiki/Ph%C3%A8dre_(Racine),_Didot,_1854
-racine_esther https://fr.wikisource.org/wiki/Esther_(Racine),_Didot,_1854
-racine_athalie https://fr.wikisource.org/wiki/Athalie_(Racine),_Didot,_1854
-corneille_place_royale https://dramacode.github.io/naked/corneillep_placeroyale.txt
-corneille_suivante https://fr.wikisource.org/wiki/La_Suivante
-corneille_galerie_du_palais https://fr.wikisource.org/wiki/La_Galerie_du_Palais
-corneille_veuve https://fr.wikisource.org/wiki/La_Veuve_(Corneille)
-corneille_clitandre https://fr.wikisource.org/wiki/Clitandre
-corneille_melite https://fr.wikisource.org/wiki/M%C3%A9lite/Texte_entier
-corneille_medee https://dramacode.github.io/naked/corneillep_medee.txt
-corneille_oedipe https://dramacode.github.io/naked/corneillep_oedipe.txt
-corneille_pertharite https://dramacode.github.io/naked/corneillep_pertharite.txt
-corneille_illusion_comique https://fr.wikisource.org/wiki/L%E2%80%99Illusion_comique_(%C3%A9dition_Didot,_1855)
