YunoHost-Apps/crabfit_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/crabfit_ynh.git synced 2024-09-03 18:16:21 +02:00
Code Issues Activity Actions

Auto-update READMEs

Browse source
This commit is contained in:
yunohost-bot 2024-04-01 20:07:23 +00:00 • committed by autoreadme_webhook
parent 7048806770
commit 8c777a89b3
4 changed files with 122 additions and 101 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
ALL_README.md Normal file
View file

@ -0,0 +1,5 @@
# All available README files by language
- [Read the README in English](README.md)
- [Irakurri README euskaraz](README_eu.md)
- [Lire le README en français](README_fr.md)

81
README.md
View file

@ -1,85 +1,58 @@
# 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.toml` 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)
* Edit the `change_url` and `config` scripts too, or remove them if you have no use of them
* Add a `LICENSE` file for the package. NB: this LICENSE file is not meant to necessarily be the LICENSE of the upstream app - it is only the LICENSE you want this package's code to published with ;). We recommend to use [the AGPL-3](https://www.gnu.org/licenses/agpl-3.0.txt).
* 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 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. It shall NOT be edited by hand.
--> -->
# Example app for YunoHost # Crab Fit for YunoHost
[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Working status](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/crabfit.svg)](https://dash.yunohost.org/appci/app/crabfit) ![Working status](https://ci-apps.yunohost.org/ci/badges/crabfit.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/crabfit.maintain.svg)
[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
*[Lire ce readme en français.](./README_fr.md)* [![Install Crab Fit with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=crabfit)
> *This package allows you to install Example app quickly and simply on a YunoHost server. *[Read this README in other languages.](./ALL_README.md)*
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
> *This package allows you to install Crab Fit 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 ## 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. Crab Fit helps you fit your event around everyone's schedules.
Simply create an event above and send the link to everyone that is participating.
Results update live and you will be able to see a heat-map of when everyone is free.
### Features ## Features
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; - Click and slide to select multiple time slots at once.
- Laboris nisi ut aliquip ex ea commodo consequat ; - Editable using a one-time password
- 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."
**Shipped version:** 1.0~ynh1 **Shipped version:** 1.0~ynh1
**Demo:** https://demo.example.com **Demo:** <https://crab.fit>
## Screenshots ## Screenshots
![Screenshot of Example app](./doc/screenshots/example.jpg) ![Screenshot of Crab Fit](./doc/screenshots/main.png)
## 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 ?
## Documentation and resources ## Documentation and resources
* Official app website: <https://example.com> - Official app website: <https://crab.fit>
* Official user documentation: <https://yunohost.org/apps> - Official user documentation: <https://github.com/GRA0007/crab.fit>
* Official admin documentation: <https://yunohost.org/packaging_apps> - Official admin documentation: <https://github.com/GRA0007/crab.fit>
* Upstream app code repository: <https://some.forge.com/example/example> - Upstream app code repository: <https://github.com/GRA0007/crab.fit>
* YunoHost documentation for this app: <https://yunohost.org/app_example> - YunoHost Store: <https://apps.yunohost.org/app/crabfit>
* Report a bug: <https://github.com/YunoHost-Apps/example_ynh/issues> - Report a bug: <https://github.com/YunoHost-Apps/crabfit_ynh/issues>
## Developer info ## 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/crabfit_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the `testing` branch, please proceed like that:
``` bash ```bash
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/crabfit_ynh/tree/testing --debug
or or
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade crabfit -u https://github.com/YunoHost-Apps/crabfit_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps> **More info regarding app packaging:** <https://yunohost.org/packaging_apps>

58
README_eu.md Normal file
View file

@ -0,0 +1,58 @@
<!--
Ohart ongi: README hau automatikoki sortu da <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>ri esker
EZ editatu eskuz.
-->
# Crab Fit YunoHost-erako
[![Integrazio maila](https://dash.yunohost.org/integration/crabfit.svg)](https://dash.yunohost.org/appci/app/crabfit) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/crabfit.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/crabfit.maintain.svg)
[![Instalatu Crab Fit YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=crabfit)
*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)*
> *Pakete honek Crab Fit YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.*
> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.*
## Aurreikuspena
Crab Fit helps you fit your event around everyone's schedules.
Simply create an event above and send the link to everyone that is participating.
Results update live and you will be able to see a heat-map of when everyone is free.
## Features
- Click and slide to select multiple time slots at once.
- Editable using a one-time password
**Paketatutako bertsioa:** 1.0~ynh1
**Demoa:** <https://crab.fit>
## Pantaila-argazkiak
![Crab Fit(r)en pantaila-argazkia](./doc/screenshots/main.png)
## Dokumentazioa eta baliabideak
- Aplikazioaren webgune ofiziala: <https://crab.fit>
- Erabiltzaileen dokumentazio ofiziala: <https://github.com/GRA0007/crab.fit>
- Administratzaileen dokumentazio ofiziala: <https://github.com/GRA0007/crab.fit>
- Jatorrizko aplikazioaren kode-gordailua: <https://github.com/GRA0007/crab.fit>
- YunoHost Denda: <https://apps.yunohost.org/app/crabfit>
- Eman errore baten berri: <https://github.com/YunoHost-Apps/crabfit_ynh/issues>
## Garatzaileentzako informazioa
Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/crabfit_ynh/tree/testing).
`testing` abarra probatzeko, ondorengoa egin:
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/crabfit_ynh/tree/testing --debug
edo
sudo yunohost app upgrade crabfit -u https://github.com/YunoHost-Apps/crabfit_ynh/tree/testing --debug
```
**Informazio gehiago aplikazioaren paketatzeari buruz:** <https://yunohost.org/packaging_apps>

79
README_fr.md
View file

@ -1,73 +1,58 @@
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator Nota bene : ce README est automatiquement généré par <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
It shall NOT be edited by hand. Il NE doit PAS être modifié à la main.
--> -->
# Exemple d'app pour YunoHost # Crab Fit pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Niveau d’intégration](https://dash.yunohost.org/integration/crabfit.svg)](https://dash.yunohost.org/appci/app/crabfit) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/crabfit.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/crabfit.maintain.svg)
[![Installer Example app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
*[Read this readme in english.](./README.md)* [![Installer Crab Fit avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=crabfit)
> *Ce package vous permet d'installer Example app rapidement et simplement sur un serveur YunoHost. *[Lire le README dans d'autres langues.](./ALL_README.md)*
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble > *Ce package vous permet d’installer Crab Fit rapidement et simplement sur un serveur YunoHost.*
> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.*
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. ## Vue d’ensemble
### Features Crab Fit vous aide à adapter votre événement aux horaires de chacun·e.
Créez simplement un événement ci-dessus et envoyez le lien à tous les participant·e·s.
Les résultats sont mis à jour en direct et vous pourrez voir une carte thermique montrant quand tout le monde est libre.
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; ## Fonctionnalités
- Laboris nisi ut aliquip ex ea commodo consequat ;
- Duis aute irure dolor in reprehenderit in voluptate ; - Glisser votre souris pour sélectionner un interval de temps
- Velit esse cillum dolore eu fugiat nulla pariatur ; - Modifiable après coup à l'aide d'un mot de passe à usage unique
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
**Version incluse :** 1.0~ynh1 **Version incluse :** 1.0~ynh1
**Démo :** https://demo.example.com **Démo :** <https://crab.fit>
## Captures d'écran ## Captures d’écran
![Capture d'écran de Example app](./doc/screenshots/example.jpg) ![Capture d’écran de Crab Fit](./doc/screenshots/main.png)
## 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 ?
## Documentations et ressources ## Documentations et ressources
* Site officiel de l'app : <https://example.com> - Site officiel de l’app : <https://crab.fit>
* Documentation officielle utilisateur : <https://yunohost.org/apps> - Documentation officielle utilisateur : <https://github.com/GRA0007/crab.fit>
* Documentation officielle de l'admin : <https://yunohost.org/packaging_apps> - Documentation officielle de l’admin : <https://github.com/GRA0007/crab.fit>
* Dépôt de code officiel de l'app : <https://some.forge.com/example/example> - Dépôt de code officiel de l’app : <https://github.com/GRA0007/crab.fit>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_example> - YunoHost Store : <https://apps.yunohost.org/app/crabfit>
* Signaler un bug : <https://github.com/YunoHost-Apps/example_ynh/issues> - Signaler un bug : <https://github.com/YunoHost-Apps/crabfit_ynh/issues>
## 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/example_ynh/tree/testing). Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/crabfit_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche `testing`, procédez comme suit :
``` bash ```bash
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/crabfit_ynh/tree/testing --debug
ou ou
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade crabfit -u https://github.com/YunoHost-Apps/crabfit_ynh/tree/testing --debug
``` ```
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps> **Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>