mirror of
https://github.com/YunoHost-Apps/moncycle_ynh.git
synced 2024-09-03 19:46:16 +02:00
Auto-update README
This commit is contained in:
yunohost-bot
parent
03bfc2ea27
commit
6247e42dfc
2 changed files with 114 additions and 81 deletions
103
README.md
103
README.md
|
|
@ -1,84 +1,95 @@
|
|||
# Packaging an app, starting from this example
|
||||
|
||||
* Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
|
||||
* Edit the `manifest.json` with app specific info.
|
||||
* Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
|
||||
* Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
|
||||
* Add a `LICENSE` file for the package.
|
||||
* Edit `doc/DISCLAIMER*.md`
|
||||
* The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||
|
||||
---
|
||||
<!--
|
||||
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.
|
||||
-->
|
||||
|
||||
# Example app for YunoHost
|
||||
# Moncycle.app for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/example)  
|
||||
[](https://install-app.yunohost.org/?app=example)
|
||||
[](https://dash.yunohost.org/appci/app/moncycle_app)  
|
||||
[](https://install-app.yunohost.org/?app=moncycle_app)
|
||||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install Example app quickly and simply on a YunoHost server.
|
||||
> *This package allows you to install Moncycle.app 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
|
||||
|
||||
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
|
||||
Rendre facile le suivi des cycles menstruels et l’application des méthodes naturelles.
|
||||
Billings . Symptothermie . FertilityCare
|
||||
|
||||
### Features
|
||||
# L’APPLICATION
|
||||
|
||||
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
|
||||
- Laboris nisi ut aliquip ex ea commodo consequat ;
|
||||
- Duis aute irure dolor in reprehenderit in voluptate ;
|
||||
- Velit esse cillum dolore eu fugiat nulla pariatur ;
|
||||
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
|
||||
👩 un tableau de suivi du cycle menstruel
|
||||
🌳 dédiée aux méthodes naturelles
|
||||
🤏 suivi de l'évolution de la glaire cervicale
|
||||
🌡️ suivi de la température corporelle (optionnel)
|
||||
🔠 notation FertilityCare (optionnel)
|
||||
📱 simple sur téléphone comme sur PC
|
||||
✨ visuel esthétique avec mode sombre
|
||||
📖 code open source
|
||||
🤪 pas de pseudo intelligence prédictive
|
||||
📊 export PDF/CSV pour vos moniteurs/instructrices
|
||||
🔢 fini Excel ou Google Sheets
|
||||
💑 un même compte sur plusieurs appareils
|
||||
✉️ envoi par mail automatique des cycles
|
||||
🔒 pas de vente de données / pas de publicité
|
||||
🇫🇷 hébergée et développée en France
|
||||
|
||||
# LES MÉTHODES NATURELLES
|
||||
|
||||
**Shipped version:** 1.0~ynh1
|
||||
Les méthodes naturelles ? «Ce sont des méthodes basées sur la connaissance des signes de fertilité du cycle féminin. Le couple peut ainsi connaitre avec précision les périodes fertiles ou infertiles qu'il traverse, et en fonction de son projet d'enfant, connaitre le meilleur moment pour transmettre la vie, ou les périodes infertiles lorsqu'il souhaite espacer ou limiter les naissances.» Source: methodes-naturelles.fr
|
||||
|
||||
**Demo:** https://demo.example.com
|
||||
Il existe plusieurs méthodes proposées par différentes associations. Voici une liste non exhaustive:
|
||||
|
||||
[Méthode Billings](https://www.methode-billings.com/)
|
||||
👉 méthode compatible avec moncycle.app
|
||||
|
||||
[Symptothermie (Cyclamen)](http://www.methodes-naturelles.fr/les_methodes_naturelles/la-methode-dauto-observation)
|
||||
👉 méthode compatible avec moncycle.app
|
||||
|
||||
[Symptothermie (SensiPlan)](https://symptothermie.info/)
|
||||
👉 méthode compatible avec moncycle.app
|
||||
|
||||
[FertilityCare (NaProTechnologie)](https://www.fertilitycare.fr/)
|
||||
👉 méthode compatible avec moncycle.app
|
||||
|
||||
🧠 moncycle.app n'a pas pour objectif de prédire ou de contrôler la bonne application des méthodes (ni de remplacer vos moniteurs) mais seulement de proposer un support numérique. Vous restez le cerveau derrière votre tableau. Si vous ne connaissez pas les méthodes naturelles ou si vous avez des questions sur les règles de celles-ci, rapprochez-vous d'un moniteur de l'une des associations ci-dessus.
|
||||
|
||||
**Shipped version:** 7.0~ynh1
|
||||
|
||||
**Demo:** https://tableau.moncycle.app/connexion.php?email1=demo@moncycle.app&mdp=demo
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
## Disclaimers / important information
|
||||
|
||||
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||
* requiring a full dedicated domain ?
|
||||
* architectures not supported ?
|
||||
* not-working single-sign on or LDAP integration ?
|
||||
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
||||
* etc...
|
||||
|
||||
* Other infos that people should be aware of, such as:
|
||||
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
||||
* how to configure / administrate the application if it ain't obvious
|
||||
* upgrade process / specificities / things to be aware of ?
|
||||
* security considerations ?
|
||||
* No LDAP integration
|
||||
* After installing, you can create your own user using the form
|
||||
* Once done, you can (if you want) set the account creation to false in `/var/www/moncycle_app/config.php`
|
||||
* If you want to use the app in PWA mode, be sure to be connected to your account first
|
||||
|
||||
## Documentation and resources
|
||||
|
||||
* Official app website: <https://example.com>
|
||||
* Official user documentation: <https://yunohost.org/apps>
|
||||
* Official admin documentation: <https://yunohost.org/packaging_apps>
|
||||
* Upstream app code repository: <https://some.forge.com/example/example>
|
||||
* YunoHost documentation for this app: <https://yunohost.org/app_example>
|
||||
* Report a bug: <https://github.com/YunoHost-Apps/example_ynh/issues>
|
||||
* Official app website: <https://moncycle.app>
|
||||
* Official user documentation: <https://www.moncycle.app>
|
||||
* Official admin documentation: <https://github.com/jean-io/moncycle.app>
|
||||
* Upstream app code repository: <https://github.com/jean-io/moncycle.app>
|
||||
* YunoHost documentation for this app: <https://yunohost.org/app_moncycle_app>
|
||||
* Report a bug: <https://github.com/YunoHost-Apps/moncycle_app_ynh/issues>
|
||||
|
||||
## Developer info
|
||||
|
||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
|
||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/moncycle_app_ynh/tree/testing).
|
||||
|
||||
To try the testing branch, please proceed like that.
|
||||
|
||||
``` bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/moncycle_app_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
sudo yunohost app upgrade moncycle_app -u https://github.com/YunoHost-Apps/moncycle_app_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
||||
|
|
|
|||
92
README_fr.md
92
README_fr.md
|
|
@ -3,71 +3,93 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
|
|||
It shall NOT be edited by hand.
|
||||
-->
|
||||
|
||||
# Example app pour YunoHost
|
||||
# Moncycle.app pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/example)  
|
||||
[](https://install-app.yunohost.org/?app=example)
|
||||
[](https://dash.yunohost.org/appci/app/moncycle_app)  
|
||||
[](https://install-app.yunohost.org/?app=moncycle_app)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
|
||||
> *Ce package vous permet d’installer Example app rapidement et simplement sur un serveur YunoHost.
|
||||
> *Ce package vous permet d’installer Moncycle.app 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
|
||||
|
||||
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
|
||||
Rendre facile le suivi des cycles menstruels et l’application des méthodes naturelles.
|
||||
Billings . Symptothermie . FertilityCare
|
||||
|
||||
### Features
|
||||
# L’APPLICATION
|
||||
|
||||
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
|
||||
- Laboris nisi ut aliquip ex ea commodo consequat ;
|
||||
- Duis aute irure dolor in reprehenderit in voluptate ;
|
||||
- Velit esse cillum dolore eu fugiat nulla pariatur ;
|
||||
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
|
||||
👩 un tableau de suivi du cycle menstruel
|
||||
🌳 dédiée aux méthodes naturelles
|
||||
🤏 suivi de l'évolution de la glaire cervicale
|
||||
🌡️ suivi de la température corporelle (optionnel)
|
||||
🔠 notation FertilityCare (optionnel)
|
||||
📱 simple sur téléphone comme sur PC
|
||||
✨ visuel esthétique avec mode sombre
|
||||
📖 code open source
|
||||
🤪 pas de pseudo intelligence prédictive
|
||||
📊 export PDF/CSV pour vos moniteurs/instructrices
|
||||
🔢 fini Excel ou Google Sheets
|
||||
💑 un même compte sur plusieurs appareils
|
||||
✉️ envoi par mail automatique des cycles
|
||||
🔒 pas de vente de données / pas de publicité
|
||||
🇫🇷 hébergée et développée en France
|
||||
|
||||
# LES MÉTHODES NATURELLES
|
||||
|
||||
**Version incluse :** 1.0~ynh1
|
||||
Les méthodes naturelles ? «Ce sont des méthodes basées sur la connaissance des signes de fertilité du cycle féminin. Le couple peut ainsi connaitre avec précision les périodes fertiles ou infertiles qu'il traverse, et en fonction de son projet d'enfant, connaitre le meilleur moment pour transmettre la vie, ou les périodes infertiles lorsqu'il souhaite espacer ou limiter les naissances.» Source: methodes-naturelles.fr
|
||||
|
||||
**Démo :** https://demo.example.com
|
||||
Il existe plusieurs méthodes proposées par différentes associations. Voici une liste non exhaustive:
|
||||
|
||||
[Méthode Billings](https://www.methode-billings.com/)
|
||||
👉 méthode compatible avec moncycle.app
|
||||
|
||||
[Symptothermie (Cyclamen)](http://www.methodes-naturelles.fr/les_methodes_naturelles/la-methode-dauto-observation)
|
||||
👉 méthode compatible avec moncycle.app
|
||||
|
||||
[Symptothermie (SensiPlan)](https://symptothermie.info/)
|
||||
👉 méthode compatible avec moncycle.app
|
||||
|
||||
[FertilityCare (NaProTechnologie)](https://www.fertilitycare.fr/)
|
||||
👉 méthode compatible avec moncycle.app
|
||||
|
||||
🧠 moncycle.app n'a pas pour objectif de prédire ou de contrôler la bonne application des méthodes (ni de remplacer vos moniteurs) mais seulement de proposer un support numérique. Vous restez le cerveau derrière votre tableau. Si vous ne connaissez pas les méthodes naturelles ou si vous avez des questions sur les règles de celles-ci, rapprochez-vous d'un moniteur de l'une des associations ci-dessus.
|
||||
|
||||
**Version incluse :** 7.0~ynh1
|
||||
|
||||
**Démo :** https://tableau.moncycle.app/connexion.php?email1=demo@moncycle.app&mdp=demo
|
||||
|
||||
## Captures d’écran
|
||||
|
||||
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||
* requiring a full dedicated domain ?
|
||||
* architectures not supported ?
|
||||
* not-working single-sign on or LDAP integration ?
|
||||
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
||||
* etc...
|
||||
|
||||
* Other infos that people should be aware of, such as:
|
||||
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
||||
* how to configure / administrate the application if it ain't obvious
|
||||
* upgrade process / specificities / things to be aware of ?
|
||||
* security considerations ?
|
||||
* No LDAP integration
|
||||
* After installing, you can create your own user using the form
|
||||
* Once done, you can (if you want) set the account creation to false in `/var/www/moncycle_app/config.php`
|
||||
* If you want to use the app in PWA mode, be sure to be connected to your account first
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
* Site officiel de l’app : <https://example.com>
|
||||
* Documentation officielle utilisateur : <https://yunohost.org/apps>
|
||||
* Documentation officielle de l’admin : <https://yunohost.org/packaging_apps>
|
||||
* Dépôt de code officiel de l’app : <https://some.forge.com/example/example>
|
||||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_example>
|
||||
* Signaler un bug : <https://github.com/YunoHost-Apps/example_ynh/issues>
|
||||
* Site officiel de l’app : <https://moncycle.app>
|
||||
* Documentation officielle utilisateur : <https://www.moncycle.app>
|
||||
* Documentation officielle de l’admin : <https://github.com/jean-io/moncycle.app>
|
||||
* Dépôt de code officiel de l’app : <https://github.com/jean-io/moncycle.app>
|
||||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_moncycle_app>
|
||||
* Signaler un bug : <https://github.com/YunoHost-Apps/moncycle_app_ynh/issues>
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/moncycle_app_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
|
||||
``` bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/moncycle_app_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
sudo yunohost app upgrade moncycle_app -u https://github.com/YunoHost-Apps/moncycle_app_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
|
||||
Loading…
Add table
Reference in a new issue