diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..d6e8f9c --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,4 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Lire le README en français](README_fr.md) diff --git a/README.md b/README.md index 413d8ff..d825dee 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,18 +9,18 @@ It shall NOT be edited by hand. [![Install ITFlow with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=itflow) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README is other languages.](./ALL_README.md)* -> *This package allows you to install ITFlow 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.* +> *This package allows you to install ITFlow 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 IT documentation, ticketing and accounting system for small MSPs. -**Shipped version:** 2024.03.03~ynh1 +**Shipped version:** 2024.03.25~ynh1 -**Demo:** https://demo.itflow.org/ +**Demo:** ## Screenshots @@ -28,22 +28,22 @@ IT documentation, ticketing and accounting system for small MSPs. ## Documentation and resources -* Official app website: -* Official admin documentation: -* Upstream app code repository: -* YunoHost Store: -* Report a bug: +- Official app website: +- Official admin documentation: +- Upstream app code repository: +- YunoHost Store: +- Report a bug: ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/itflow_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/itflow_ynh/tree/testing). -To try the testing branch, please proceed like that. +To try the `testing` branch, please proceed like that: -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/itflow_ynh/tree/testing --debug or sudo yunohost app upgrade itflow -u https://github.com/YunoHost-Apps/itflow_ynh/tree/testing --debug ``` -**More info regarding app packaging:** \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 95d31df..9cbaf92 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # ITFlow pour YunoHost @@ -9,18 +9,18 @@ It shall NOT be edited by hand. [![Installer ITFlow avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=itflow) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer ITFlow 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.* +> *Ce package vous permet d’installer ITFlow rapidement et simplement sur un serveur YunoHost.* +> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* ## Vue d’ensemble Système de documentation, de billetterie et de comptabilité pour les petits MSP -**Version incluse :** 2024.03.03~ynh1 +**Version incluse :** 2024.03.25~ynh1 -**Démo :** https://demo.itflow.org/ +**Démo :** ## Captures d’écran @@ -28,22 +28,22 @@ Système de documentation, de billetterie et de comptabilité pour les petits MS ## Documentations et ressources -* Site officiel de l’app : -* Documentation officielle de l’admin : -* Dépôt de code officiel de l’app : -* YunoHost Store: -* Signaler un bug : +- Site officiel de l’app : +- Documentation officielle de l’admin : +- Dépôt de code officiel de l’app : +- YunoHost Store : +- Signaler un bug : ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/itflow_ynh/tree/testing). +Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/itflow_ynh/tree/testing). -Pour essayer la branche testing, procédez comme suit. +Pour essayer la branche `testing`, procédez comme suit : -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/itflow_ynh/tree/testing --debug ou sudo yunohost app upgrade itflow -u https://github.com/YunoHost-Apps/itflow_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** \ No newline at end of file +**Plus d’infos sur le packaging d’applications :**