README.md

@@ -1,31 +1,55 @@
-# Présentation
+mkht.php is a PHP script for building Gemini, Markdown and HTML/CSS sites from source documents in Gemini, Markdown, HTML, PHP, CSS and Less.
 
-Ceci est le code source du générateur de sites statiques qui créé le [site web d'Antopie](https://antopie.org).
+# Usage
 
-# Utilisation
+Place your pages tree in `/src/*/*.(gmi|md)`.
 
-`compil.php <chemin du site> <destination> <nom du site>`
+Optionnal files:
+* `/config.ini`
+* `/style.less`
+* `/logo.png`
+* `/head.inc.html`
+* `/footer.inc.html`
 
-Avec `destination` :
-* Pour déployer en DNS en liant vers `page`, utiliser `dns`.
-* Pour déployer en Onion en liant vert `page`, utiliser `onion`.
-* Pour déployer en DNS en liant vert `page.html`, utiliser `local`.
+`mkht.php <site path> <destination >`
 
-Exemple pour le site d'Antopie : `compil.php antopie local Antopie`
+`destination` is optionnal and can be:
+* `dns` if you want local links without exensions
+* `onion` if you want links ending with .onion when available
 
-# Bibliothèques utilisées
+# Input
 
-Le dossier `bibli` contient les dépendances incluses dans le générateur de sites :
+Pages in `/src`can use Gemini (if using `gmi` extension), Markdown, HTML and PHP.
 
-| Nom       | Description                 | Source                                     |
-| --------- | --------------------------- | ------------------------------------------ |
-| less.php  | Compilateur Less en PHP     | https://github.com/wikimedia/less.php      |
-| parsedown | Compilateur Markdown en PHP | https://parsedown.org                      |
+# Output
 
-# Licence
+* `/*/*.gmi` (if using `.gmi` extension in /src)
+* `/*/*.md`
+* `/*/*.html`
+* `/*/*.gz`
 
-Le générateur de sites web d'Antopie est un logiciel libre ; vous pouvez le diffuser et le modifier suivant les termes de la GNU Affero General Public License telle que publiée par la Free Software Foundation ; soit la version 3 de cette licence, soit (à votre convenance) une version ultérieure.
+Note that format translation is only done in the following order:
+Gemini > Markdown > HTML, which means that the last of these formats you will use will be the first that will be readable by hypertext browsers. (PHP is executed before.)
 
-Le générateur de sites web d'Antopie est diffusé dans l’espoir qu’il sera utile, mais SANS AUCUNE GARANTIE ; sans même une garantie implicite de COMMERCIALISATION ou d’ADÉQUATION À UN USAGE PARTICULIER. Voyez la GNU Affero General Public License pour plus de détails.
+# External dependencies
 
-Vous devriez avoir reçu une copie de la GNU Affero General Public License avec ce code. Sinon, consultez https://www.gnu.org/licenses/
+* PHP
+* gzip
+* find
+
+# Internal libraries used
+
+| Name      | Description              | Source                                     |
+| --------- | ------------------------ | ------------------------------------------ |
+| less.php  | Less compiler in PHP     | https://github.com/wikimedia/less.php      |
+| parsedown | Markdown compiler in PHP | https://parsedown.org                      |
+
+# License
+
+[AGPLv3+](LICENSE)
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.