From dedc09b254c2305beac950d4b18820fceea68f73 Mon Sep 17 00:00:00 2001 From: farvardin Date: Thu, 23 Apr 2020 12:36:08 +0200 Subject: [PATCH] update doc: --- README.md | 11 ++++++++--- README_fr.md | 9 ++++++++- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 62d82a6..9497b88 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ # Lionwiki-t2t for YunoHost - *[Lire ce readme en français.](./README_fr.md)* > *This package allow you to install Lionwiki-t2t quickly and simply on a YunoHost server. @@ -11,7 +10,7 @@ If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to ## Overview -LionWiki is a minimalist Wiki engine programmed in PHP. It is extensible, templatable, file based (it doesn't need database like MySQL) and requires just one file to function (30 kb). It is suitable for small websites, personal notebooks or journals. This version is using the lightweight markup language TXT2TAGS. +LionWiki-t2t is a minimalist Wiki engine programmed in PHP. It is extensible, templatable, file based (it doesn't need database like MySQL) and requires just one file to function (30 kb). It is suitable for small websites, personal notebooks or journals. This version is using the lightweight markup language TXT2TAGS. ## Screenshot @@ -21,7 +20,12 @@ LionWiki is a minimalist Wiki engine programmed in PHP. It is extensible, templa ## Configuration -In the root folder of this app, there are two files: config.php and config.t2t for changing password and general behavior. +In the root folder of this app, there are two files: config.php and config.t2t + +- config.php is for changing password, the template used, default page. You can also define an administrator password which has some more rights (it's possible to lock some pages and modify them only with the administrator password, add some IP address to a blacklist) + +- config.t2t is for tweaking your wiki syntax. You can define more tags (using the txt2tags rules) for specific behaviors. + ## Documentation @@ -87,6 +91,7 @@ cp templates/minimaxing/minimaxing_org.css templates/minimaxing/minimaxing.css ## License + MIT license diff --git a/README_fr.md b/README_fr.md index 192a301..1ee0efa 100644 --- a/README_fr.md +++ b/README_fr.md @@ -20,7 +20,12 @@ Lionwiki-t2t est un système de type wiki minimaliste, programmé en PHP. Il est ## Configuration -Dans le dossier racine de l'application il y a 2 fichiers, config.php et config.t2t qui permettent de modifier le mot de passe et le comportement général. +Dans le dossier racine de l'application il y a 2 fichiers, config.php et config.t2t + +- config.php permet de modifier le mot de passe, le choix du template utilisé et la page par défaut. Vous pouvez également définir ici un mot de passe administrateur (pour bloquer certaines pages en édition) + +- config.t2t est pour customiser votre syntaxe wiki. Vous pouvez définir là de nouvelles balises (utilisant les règles txt2tags) pour des comportements spécifiques. + ## Documentation @@ -78,8 +83,10 @@ cp templates/minimaxing/minimaxing_org.css templates/minimaxing/minimaxing.css ``` ## Licence + Licence MIT + ## Liens * Signaler un bug: https://github.com/farvardin/lionwiki-t2t_ynh/issues