diff --git a/README.md b/README.md index 2e87dd7..2313185 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,39 @@ -# Tyto for YunoHost ![alt tag](https://github.com/YunoHost-Apps/tyto_ynh/blob/master/68747470733a2f2f7261772e6769746875622e636f6d2f6a6833792f7479746f2f6d61737465722f7372632f696d672f7479746f2e706e67.png) + + +# Tyto for YunoHost [![Integration level](https://dash.yunohost.org/integration/tyto.svg)](https://dash.yunohost.org/appci/app/tyto) ![](https://ci-apps.yunohost.org/ci/badges/tyto.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/tyto.maintain.svg) -[![Install Tyto with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=tyto) +[![Install Tyto with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=tyto) -> *This package allows you to install Tyto quickly and simply on a YunoHost server. +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Tyto 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 -Tyto arose from the want for an electronic post-it board without the need for accounts. Something simple and intuitive that could be easily shared. -**Shipped version:** 3.0.4 +Simple, minimal electronic post-it board + +**Shipped version:** 3.0.4~ynh2 + +**Demo:** https://jh3y.github.io/tyto/ ## Screenshots -![](https://github.com/YunoHost-Apps/tyto_ynh/blob/master/68747470733a2f2f7261772e6769746875622e636f6d2f6a6833792f706963732f6d61737465722f7479746f2f6164645f7461736b2e676966.gif.) +![](./doc/screenshots/screenshot.png) -## Demo +## Documentation and resources -* [Official demo](https://jh3y.github.io/tyto) +* Official app website: https://jh3y.github.io/tyto/ +* Official user documentation: https://yunohost.org/apps +* Upstream app code repository: https://github.com/jh3y/tyto +* YunoHost documentation for this app: https://yunohost.org/app_tyto +* Report a bug: https://github.com/YunoHost-Apps/tyto_ynh/issues - -### Features -* minimal UI -* no accounts necessary -* intuitive -* extensible -* localStorage persistence -* time tracking -* sortable UI -* task linking -* Markdown support -* etc. - -## YunoHost specific features - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/tyto%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/tyto/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/tyto%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/tyto/) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/tyto_ynh/issues - * Upstream app repository: https://github.com/jh3y/tyto - * YunoHost website: https://yunohost.org/ - ---- - -Developer info ----------------- +## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/tyto_ynh/tree/testing). @@ -58,3 +43,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/tyto_ynh/tree/testing or sudo yunohost app upgrade tyto -u https://github.com/YunoHost-Apps/tyto_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 new file mode 100644 index 0000000..008876c --- /dev/null +++ b/README_fr.md @@ -0,0 +1,43 @@ +# Tyto pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/tyto.svg)](https://dash.yunohost.org/appci/app/tyto) ![](https://ci-apps.yunohost.org/ci/badges/tyto.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/tyto.maintain.svg) +[![Installer Tyto avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=tyto) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Tyto 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 + +Tableau de post-it électroniques, simple et minimaliste + +**Version incluse :** 3.0.4~ynh2 + +**Démo :** https://jh3y.github.io/tyto/ + +## Captures d'écran + +![](./doc/screenshots/screenshot.png) + +## Documentations et ressources + +* Site officiel de l'app : https://jh3y.github.io/tyto/ +* Documentation officielle utilisateur : https://yunohost.org/apps +* Dépôt de code officiel de l'app : https://github.com/jh3y/tyto +* Documentation YunoHost pour cette app : https://yunohost.org/app_tyto +* Signaler un bug : https://github.com/YunoHost-Apps/tyto_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/tyto_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/tyto_ynh/tree/testing --debug +ou +sudo yunohost app upgrade tyto -u https://github.com/YunoHost-Apps/tyto_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file