mirror of
https://github.com/YunoHost-Apps/chtickynotes_ynh.git
synced 2024-09-03 18:15:57 +02:00
Auto-update README
This commit is contained in:
parent
dddadffd75
commit
e321f7d72b
2 changed files with 54 additions and 76 deletions
59
README.md
59
README.md
|
@ -1,16 +1,23 @@
|
||||||
|
<!--
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
# ChtickyNotes for YunoHost
|
# 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)
|
[![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)*
|
*[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.*
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||||
|
|
||||||
## Overview
|
## 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
|
- notes movable and resizable
|
||||||
- edit note by just typing on it (or CTRL-V to paste chunks of HTML)
|
- 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
|
- 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
|
- autosave every 10 seconds
|
||||||
- storage on the server (not on the browser local storage)
|
- storage on the server (not on the browser local storage)
|
||||||
|
|
||||||
**Shipped version:** 1.0
|
|
||||||
|
**Shipped version:** 1.0~ynh4
|
||||||
|
|
||||||
## Screenshots
|
## 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
|
- **Upstream not maintained**: This software is not maintained anymore. Expect it to break down over time, be exposed to unfixed security breaches, etc.
|
||||||
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
|
|
||||||
|
|
||||||
## YunoHost specific features
|
## Documentation and resources
|
||||||
|
|
||||||
#### Multi-user support
|
* Upstream app code repository: <https://github.com/YunoHost-Apps/chtickynotes_ynh/>
|
||||||
|
* YunoHost documentation for this app: <https://yunohost.org/app_chtickynotes>
|
||||||
* Are LDAP and HTTP auth supported?
|
* Report a bug: <https://github.com/YunoHost-Apps/chtickynotes_ynh/issues>
|
||||||
* 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/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Developer info
|
## Developer info
|
||||||
|
|
||||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing).
|
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.
|
To try the testing branch, please proceed like that.
|
||||||
```
|
|
||||||
|
``` bash
|
||||||
sudo yunohost app install https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing --debug
|
sudo yunohost app install https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing --debug
|
||||||
or
|
or
|
||||||
sudo yunohost app upgrade chtickynotes -u https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing --debug
|
sudo yunohost app upgrade chtickynotes -u https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
||||||
|
|
71
README_fr.md
71
README_fr.md
|
@ -1,68 +1,57 @@
|
||||||
|
<!--
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
# ChtickyNotes pour YunoHost
|
# 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)
|
[![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)
|
||||||
[![Install ChtickyNotes with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=chtickynotes)
|
[![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.
|
> *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.*
|
Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.*
|
||||||
|
|
||||||
## Overview
|
## Vue d’ensemble
|
||||||
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 :
|
ChtickyNotes est une application "post-it" basé sur [Post It All!](Https://github.com/txusko/PostItAll).
|
||||||
|
|
||||||
|
## Caractéristiques :
|
||||||
- notes mobiles et redimensionnables
|
- 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 sur chaque note pour changer sa couleur...
|
||||||
- menu global pour changer de tableau...
|
- menu global pour changer de tableau...
|
||||||
- sauvegarde automatique toutes les 10 secondes
|
- sauvegarde automatique toutes les 10 secondes
|
||||||
- stockage sur le serveur (pas de stockage local dans le navigateur)
|
- 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.
|
## :red_circle: Fonctions indésirables
|
||||||
* Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer.
|
|
||||||
|
|
||||||
## 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 ?
|
* Dépôt de code officiel de l’app : <https://github.com/YunoHost-Apps/chtickynotes_ynh/>
|
||||||
* L'application peut-elle être utilisée par plusieurs utilisateurs ?
|
* Documentation YunoHost pour cette app : <https://yunohost.org/app_chtickynotes>
|
||||||
|
* Signaler un bug : <https://github.com/YunoHost-Apps/chtickynotes_ynh/issues>
|
||||||
#### 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/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Informations pour les développeurs
|
## Informations pour les développeurs
|
||||||
|
|
||||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing).
|
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.
|
Pour essayer la branche testing, procédez comme suit.
|
||||||
```
|
|
||||||
|
``` bash
|
||||||
sudo yunohost app install https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing --debug
|
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
|
sudo yunohost app upgrade chtickynotes -u https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
|
Loading…
Reference in a new issue