diff --git a/README.md b/README.md index 18f48c4..3679653 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + + # Kanboard for YunoHost [![Integration level](https://dash.yunohost.org/integration/kanboard.svg)](https://dash.yunohost.org/appci/app/kanboard) ![](https://ci-apps.yunohost.org/ci/badges/kanboard.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/kanboard.maintain.svg) @@ -5,40 +10,22 @@ *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install Kanboard 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 Kanboard 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 -Kanboard is a visual task manager that makes it easy to manage small projects in a collaborative way. The tool is particularly suitable for people who use the Kanban method. Kanboard can be seen as a (Simplified) alternative to the proprietary Trello software. Kanboard is a minimalist software, it focuses only on the features that are really necessary. The user interface is simple and clear. The tool is designed to run on a small machine such as a Raspberry Pi or a Virtual Private Server (VPS). There are no external dependencies, drag and drop of tasks uses the new HTML5 APIs. -**Shipped version:** 1.2.18 +Kanban project management software + +**Shipped version:** 1.2.19~ynh1 + +**Demo:** https://demo.yunohost.org/kanboard/ ## Screenshots -![](https://kanboard.org/assets/img/board.png) +![](./doc/screenshots/board.png) -## Demo - -* [YunoHost demo](https://demo.yunohost.org/kanboard/) - -## Configuration - -## Documentation - - * Official documentation: https://docs.kanboard.org/en/latest/ - * YunoHost documentation: https://yunohost.org/#/app_kanboard - -## YunoHost specific features - -#### Multi-users support - - * Are LDAP and HTTP auth supported? **No** - * Can the app be used by multiple users? **Yes** - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/kanboard%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/kanboard/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/kanboard%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/kanboard/) +## Disclaimers / important information ## Limitations @@ -54,18 +41,18 @@ Then you can connect. This is due to a Kanboard limitation. -## Links +## Documentation and resources - * Report a bug: https://github.com/YunoHost-Apps/kanboard_ynh/issues - * Kanboard website: https://kanboard.org - * Upstream app repository: https://github.com/kanboard/kanboard - * YunoHost website: https://yunohost.org/ +* Official app website: https://kanboard.net +* Official user documentation: https://yunohost.org/#/app_kanboard +* Official admin documentation: https://docs.kanboard.org/en/latest/ +* Upstream app code repository: https://github.com/kanboard/kanboard +* YunoHost documentation for this app: https://yunohost.org/app_kanboard +* Report a bug: https://github.com/YunoHost-Apps/kanboard_ynh/issues ---- +## Developer info -## Developers info - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/kanboard_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/kanboard_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -73,3 +60,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/kanboard_ynh/tree/tes or sudo yunohost app upgrade kanboard -u https://github.com/YunoHost-Apps/kanboard_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index 67db2dc..05c364f 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,44 +1,27 @@ # Kanboard pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/kanboard.svg)](https://dash.yunohost.org/appci/app/kanboard) ![](https://ci-apps.yunohost.org/ci/badges/kanboard.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/kanboard.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/kanboard.svg)](https://dash.yunohost.org/appci/app/kanboard) ![](https://ci-apps.yunohost.org/ci/badges/kanboard.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/kanboard.maintain.svg) [![Installer Kanboard avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=kanboard) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Kanboard rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.* +> *Ce package vous permet d'installer Kanboard 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 -Kanboard est un gestionnaire de tâches visuel qui permet de gérer facilement des petits projets de manière collaborative. L'outil est particulièrement adapté aux personnes qui utilisent la méthode Kanban. On peut voir Kanboard comme une alternative (simplifiée) au logiciel propriétaire Trello. Kanboard est un logiciel minimaliste, il se concentre uniquement sur les fonctionnalités réellement nécessaires. L'interface utilisateur est simple et clair. L'outil est prévu pour fonctionner sur une petite machine tel qu'un Raspberry Pi ou un serveur virtuel privé (VPS). Il n'y a aucune dépendance externe, le glisser-déposer des tâches utilise les nouvelles API de HTML5. -**Version incluse :** 1.2.18 +Logiciel de gestion de projet Kanban + +**Version incluse :** 1.2.19~ynh1 + +**Démo :** https://demo.yunohost.org/kanboard/ ## Captures d'écran -![](https://kanboard.org/assets/img/board.png) +![](./doc/screenshots/board.png) -## Démo - -* [Démo YunoHost](https://demo.yunohost.org/kanboard/) - -## Configuration - -## Documentation - - * Documentation officielle : https://docs.kanboard.org/fr/latest/ - * Documentation YunoHost : https://yunohost.org/#/app_kanboard_fr - -## Caractéristiques spécifiques YunoHost - -#### Support multi-utilisateur - -* L'authentification LDAP et HTTP est-elle prise en charge ? **Non** -* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui** - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/kanboard%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/kanboard/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/kanboard%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/kanboard/) +## Avertissements / informations importantes ## Limitations @@ -54,14 +37,14 @@ Ensuite, vous pouvez vous connecter. Cela est dû à une limitation de Kanboard. -## Liens +## Documentations et ressources - * Signaler un bug : https://github.com/YunoHost-Apps/kanboard_ynh/issues - * Site de l'application : https://kanboard.org - * Dépôt de l'application principale : https://github.com/kanboard/kanboard - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : https://kanboard.net +* Documentation officielle utilisateur : https://yunohost.org/#/app_kanboard +* Documentation officielle de l'admin : https://docs.kanboard.org/en/latest/ +* Dépôt de code officiel de l'app : https://github.com/kanboard/kanboard +* Documentation YunoHost pour cette app : https://yunohost.org/app_kanboard +* Signaler un bug : https://github.com/YunoHost-Apps/kanboard_ynh/issues ## Informations pour les développeurs @@ -73,3 +56,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/kanboard_ynh/tree/tes ou sudo yunohost app upgrade kanboard -u https://github.com/YunoHost-Apps/kanboard_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file