mirror of
https://github.com/YunoHost-Apps/lionwiki-t2t_ynh.git
synced 2024-09-03 19:36:27 +02:00
Auto-update README
This commit is contained in:
parent
ffbf905c00
commit
5dc9de1793
2 changed files with 54 additions and 60 deletions
57
README.md
57
README.md
|
@ -1,22 +1,30 @@
|
|||
# Lionwiki-t2t for YunoHost
|
||||
<!--
|
||||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||
It shall NOT be edited by hand.
|
||||
-->
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/lionwiki-t2t)  
|
||||
[](https://install-app.yunohost.org/?app=lionwiki-t2t)
|
||||
# Lionwiki for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/lionwiki-t2t)  
|
||||
[](https://install-app.yunohost.org/?app=lionwiki-t2t)
|
||||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allow you to install Lionwiki-t2t quickly and simply on a YunoHost server.
|
||||
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
|
||||
> *This package allows you to install Lionwiki quickly and simply on a YunoHost server.
|
||||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||
|
||||
## Overview
|
||||
|
||||
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.
|
||||
|
||||
**Shipped version:** 3.2.12e
|
||||
|
||||
## Screenshot
|
||||
**Shipped version:** 3.2.12~ynh2
|
||||
|
||||

|
||||
## Screenshots
|
||||
|
||||

|
||||
|
||||
## Disclaimers / important information
|
||||
|
||||
## Configuration
|
||||
|
||||
|
@ -28,13 +36,6 @@ In the root folder of this app, there are two files: `config.php` and `config.t2
|
|||
|
||||
The `pheditor.php` tool at the root of the site allows you to edit all the necessary configuration files. You can remove or rename it from its interface. The password is the same as the one defined during installation.
|
||||
|
||||
## Documentation
|
||||
|
||||
* Official documentation: https://lionwiki-t2t.sourceforge.io/
|
||||
* More about txt2tags: https://github.com/farvardin/whatistxt2tags
|
||||
|
||||
## YunoHost specific features
|
||||
|
||||
#### Multi-users support
|
||||
|
||||
This is only a single password for editing the wiki (it's not multi-user), and one other password for administration. Both are set to the same one defined in the lionwiki-t2t during the installation by YunoHost.
|
||||
|
@ -43,15 +44,6 @@ You can set the wiki to private (only readable when you are connected to YunoHos
|
|||
|
||||
You can install multiple instance of this app.
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/lionwikit2t/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/lionwikit2t/)
|
||||
|
||||
## Limitations
|
||||
|
||||
* No different user accounts.
|
||||
|
||||
## Additional information
|
||||
|
||||
You must define a base color during the installation (in hexadecimal format). You can choose it using this online tool for example: https://www.w3schools.com/colors/colors_picker.asp
|
||||
|
@ -85,21 +77,26 @@ If something goes wrong, you can go back to the original default file:
|
|||
cp templates/minimaxing/minimaxing_org.css templates/minimaxing/minimaxing.css
|
||||
```
|
||||
|
||||
## Links
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/lionwiki-t2t_ynh/issues
|
||||
* App website: https://lionwiki-t2t.sourceforge.io/
|
||||
* YunoHost website: https://yunohost.org/
|
||||
## Documentation and resources
|
||||
|
||||
---
|
||||
* Official app website: <https://lionwiki-t2t.sourceforge.io/>
|
||||
* Official user documentation: <https://github.com/farvardin/whatistxt2tags>
|
||||
* Official admin documentation: <https://lionwiki-t2t.sourceforge.io/>
|
||||
* Upstream app code repository: <https://sourceforge.net/projects/lionwiki-t2t>
|
||||
* YunoHost documentation for this app: <https://yunohost.org/app_lionwiki-t2t>
|
||||
* Report a bug: <https://github.com/YunoHost-Apps/lionwiki-t2t_ynh/issues>
|
||||
|
||||
## Developer info
|
||||
|
||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/lionwiki-t2t_ynh/tree/testing).
|
||||
|
||||
To try the testing branch, please proceed like that.
|
||||
```
|
||||
|
||||
``` bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/lionwiki-t2t_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade lionwiki-t2t -u https://github.com/YunoHost-Apps/lionwiki-t2t_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
||||
|
|
57
README_fr.md
57
README_fr.md
|
@ -1,22 +1,30 @@
|
|||
# Lionwiki-t2t pour YunoHost
|
||||
<!--
|
||||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||
It shall NOT be edited by hand.
|
||||
-->
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/lionwiki-t2t)  
|
||||
[](https://install-app.yunohost.org/?app=lionwiki-t2t)
|
||||
# Lionwiki pour YunoHost
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
[](https://dash.yunohost.org/appci/app/lionwiki-t2t)  
|
||||
[](https://install-app.yunohost.org/?app=lionwiki-t2t)
|
||||
|
||||
> *Ce package vous permet d'installer Lionwiki-t2t rapidement et simplement sur un serveur Yunohost.
|
||||
*[Read this readme in english.](./README.md)*
|
||||
|
||||
> *Ce package vous permet d'installer Lionwiki rapidement et simplement sur un serveur YunoHost.
|
||||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
Lionwiki-t2t est un système de type wiki minimaliste, programmé en PHP. Il est extensible et n'utilise que des fichiers plats pour sa base de données. Il est adapté pour la création de petits sites web, de notes personnelles ou de journaux. Cette version utilise le langage de balisage léger TXT2TAGS.
|
||||
|
||||
**Version incluse :** 3.2.11b
|
||||
|
||||
## Capture d'écran
|
||||
**Version incluse :** 3.2.12~ynh2
|
||||
|
||||

|
||||
## Captures d'écran
|
||||
|
||||

|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
## Configuration
|
||||
|
||||
|
@ -28,28 +36,12 @@ Dans le dossier racine de l'application il y a 2 fichiers, `config.php` et `conf
|
|||
|
||||
- L'outil `pheditor.php` à la racine du site permet d'éditer tous les fichiers de configuration nécessaires. Vous pouvez le retirer ou le renommer depuis son interface. Le mot de passe est le même que celui définit lors de l'installation.
|
||||
|
||||
## Documentation
|
||||
|
||||
* Documentation officielle : https://lionwiki-t2t.sourceforge.io/
|
||||
* À propos de txt2tags : https://github.com/farvardin/whatistxt2tags
|
||||
|
||||
## Caractéristiques spécifiques YunoHost
|
||||
|
||||
#### Support multi-utilisateurs
|
||||
|
||||
Il y a un seul mot de passe pour éditer ce wiki (dans le fichier config.php), et un autre pour l'administration. C'est le même qui a a été créé lors de l'installation par YunoHost.
|
||||
|
||||
Vous pouvez passer le wiki en mode privé ou public, selon vos usages.
|
||||
|
||||
#### Architectures supportées
|
||||
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/lionwikit2t/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/lionwikit2t/)
|
||||
|
||||
## Limitations
|
||||
|
||||
* Un seul compte utilisateur.
|
||||
|
||||
## Informations additionnelles
|
||||
|
||||
Vous devez définir une couleur de base durant l'installation, au format hexadécimal. Vous pouvez la choisir en utilisant cet outil en ligne : https://www.w3schools.com/colors/colors_picker.asp
|
||||
|
@ -83,21 +75,26 @@ Si quelque chose se passe mal, vous pouvez revenir au fichier original :
|
|||
cp templates/minimaxing/minimaxing_org.css templates/minimaxing/minimaxing.css
|
||||
```
|
||||
|
||||
## Liens
|
||||
|
||||
* Signaler un bug: https://github.com/YunoHost-Apps/lionwiki-t2t_ynh/issues
|
||||
* Site de l'application: https://lionwiki-t2t.sourceforge.io/
|
||||
* Site web YunoHost: https://yunohost.org/
|
||||
## Documentations et ressources
|
||||
|
||||
---
|
||||
* Site officiel de l'app : <https://lionwiki-t2t.sourceforge.io/>
|
||||
* Documentation officielle utilisateur : <https://github.com/farvardin/whatistxt2tags>
|
||||
* Documentation officielle de l'admin : <https://lionwiki-t2t.sourceforge.io/>
|
||||
* Dépôt de code officiel de l'app : <https://sourceforge.net/projects/lionwiki-t2t>
|
||||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_lionwiki-t2t>
|
||||
* Signaler un bug : <https://github.com/YunoHost-Apps/lionwiki-t2t_ynh/issues>
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/lionwiki-t2t_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
|
||||
``` bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/lionwiki-t2t_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade lionwiki-t2t -u https://github.com/YunoHost-Apps/lionwiki-t2t_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
|
||||
|
|
Loading…
Add table
Reference in a new issue