diff --git a/README.md b/README.md index fae8fa0..978a6b2 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,23 @@ + + # ChtickyNotes for YunoHost -[![Integration level](https://dash.yunohost.org/integration/chtickynotes.svg)](https://dash.yunohost.org/appci/app/chtickynotes) ![](https://ci-apps.yunohost.org/ci/badges/chtickynotes.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/chtickynotes.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/chtickynotes.svg)](https://dash.yunohost.org/appci/app/chtickynotes) ![Working status](https://ci-apps.yunohost.org/ci/badges/chtickynotes.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/chtickynotes.maintain.svg) [![Install ChtickyNotes with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=chtickynotes) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install ChtickyNotes quickly and simply on a YunoHost server. +> *This package allows you to install ChtickyNotes 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 -ChtickyNotes core is based on [Post It All!](https://github.com/txusko/PostItAll). -ChtickyNotes is a "simple post-it" application. Its main features are: + +ChtickyNotes is a "simple post-it" based on [Post It All!](https://github.com/txusko/PostItAll). + +##Features: - notes movable and resizable - edit note by just typing on it (or CTRL-V to paste chunks of HTML) - menu on each note to change its color, and so on @@ -18,51 +25,33 @@ ChtickyNotes is a "simple post-it" application. Its main features are: - autosave every 10 seconds - storage on the server (not on the browser local storage) -**Shipped version:** 1.0 + +**Shipped version:** 1.0~ynh4 ## Screenshots -![](https://lh4.googleusercontent.com/-ATC-XA5iVsc/VM06cI3ClLI/AAAAAAAACHo/uBhDViaSBRg/s800/chtickynotes.gif) +![Screenshot of ChtickyNotes](./doc/screenshots/chtickynotes.gif) -## Documentation +## :red_circle: Antifeatures - * Official documentation: Link to the official documentation of this app - * YunoHost documentation: If specific documentation is needed, feel free to contribute. +- **Upstream not maintained**: This software is not maintained anymore. Expect it to break down over time, be exposed to unfixed security breaches, etc. -## YunoHost specific features +## Documentation and resources -#### Multi-user support - -* Are LDAP and HTTP auth supported? -* Can the app be used by multiple users? - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/chtickynotes.svg)](https://ci-apps.yunohost.org/ci/apps/chtickynotes/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/chtickynotes.svg)](https://ci-apps-arm.yunohost.org/ci/apps/chtickynotes/) - -## Limitations - -* Any known limitations. - -## Additional information - -* Other info you would like to add about this app. - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/chtickynotes_ynh/issues - * YunoHost website: https://yunohost.org/ - ---- +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing --debug or sudo yunohost app upgrade chtickynotes -u https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 729ed99..5888638 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,68 +1,57 @@ + + # ChtickyNotes pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/chtickynotes.svg)](https://dash.yunohost.org/appci/app/chtickynotes) ![](https://ci-apps.yunohost.org/ci/badges/chtickynotes.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/chtickynotes.maintain.svg) -[![Install ChtickyNotes with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=chtickynotes) +[![Niveau d’intégration](https://dash.yunohost.org/integration/chtickynotes.svg)](https://dash.yunohost.org/appci/app/chtickynotes) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/chtickynotes.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/chtickynotes.maintain.svg) +[![Installer ChtickyNotes avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=chtickynotes) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* -> *Ce package vous permet d'installer ChtickyNotes 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 ChtickyNotes 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.* -## Overview -Le noyau de ChtickyNotes est basé sur [Post It All!](Https://github.com/txusko/PostItAll). -ChtickyNotes est une application "post-it". Ses principales caractéristiques sont : +## Vue d’ensemble + +ChtickyNotes est une application "post-it" basé sur [Post It All!](Https://github.com/txusko/PostItAll). + +## Caractéristiques : - notes mobiles et redimensionnables -- éditer la note en tapant simplement dessus (ou CTRL-V pour coller du code HTML) +- ?iter la note en tapant simplement dessus (ou CTRL-V pour coller du code HTML) - menu sur chaque note pour changer sa couleur... - menu global pour changer de tableau... - sauvegarde automatique toutes les 10 secondes - stockage sur le serveur (pas de stockage local dans le navigateur) -**Version incluse :** 1.0 -## Captures d'écran +**Version incluse :** 1.0~ynh4 -![](https://lh4.googleusercontent.com/-ATC-XA5iVsc/VM06cI3ClLI/AAAAAAAACHo/uBhDViaSBRg/s800/chtickynotes.gif) +## Captures d’écran -## Documentation +![Capture d’écran de ChtickyNotes](./doc/screenshots/chtickynotes.gif) - * Documentation officielle : Lien vers la documentation officielle de cette application. - * Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer. +## :red_circle: Fonctions indésirables -## Caractéristiques spécifiques YunoHost +- **Upstream not maintained**: This software is not maintained anymore. Expect it to break down over time, be exposed to unfixed security breaches, etc. -#### Support multi-utilisateur +## Documentations et ressources -* L'authentification LDAP et HTTP est-elle prise en charge ? -* L'application peut-elle être utilisée par plusieurs utilisateurs ? - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/chtickynotes.svg)](https://ci-apps.yunohost.org/ci/apps/chtickynotes/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/chtickynotes.svg)](https://ci-apps-arm.yunohost.org/ci/apps/chtickynotes/) - -## Limitations - -* Limitations connues. - -## Informations additionnelles - -* Autres informations que vous souhaitez ajouter sur cette application. - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/chtickynotes_ynh/issues - * Site web YunoHost : https://yunohost.org/ - ---- +* Dépôt de code officiel de l’app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing --debug -or +ou sudo yunohost app upgrade chtickynotes -u https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing --debug ``` + +**Plus d’infos sur le packaging d’applications :** \ No newline at end of file