YunoHost-Apps/microbin_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/microbin_ynh.git synced 2024-09-03 19:45:57 +02:00
Code Issues Activity Actions

Auto-update READMEs

Browse source
This commit is contained in:
yunohost-bot 2024-04-04 10:55:56 +00:00 • committed by autoreadme_webhook
parent acda560cc0
commit 68ccda63fa
5 changed files with 147 additions and 107 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
ALL_README.md Normal file
View file

@ -0,0 +1,6 @@
# 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)
- [Le o README en galego](README_gl.md)

79
README.md
View file

@ -1,85 +1,48 @@
# Packaging an app, starting from this example
* Copy this app before working on it, using the ['Use this template'](https://github.com/new?template_name=example_ynh&template_owner=YunoHost) 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 files under the `doc/` directory
* 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 # Microbin 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/microbin.svg)](https://dash.yunohost.org/appci/app/microbin) ![Working status](https://ci-apps.yunohost.org/ci/badges/microbin.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/microbin.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 Microbin with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=microbin)
> *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 Microbin 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. MicroBin is a super tiny, feature rich, configurable, self-contained and self-hosted paste bin web application. It is very easy to set up and use, and will only require a few megabytes of memory and disk storage. It takes only a couple minutes to set it up, why not give it a try now?
### Features **Shipped version:** 2.0.4~ynh1
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; **Demo:** <https://pub.microbin.eu/>
- 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."
**Shipped version:** 1.0~ynh1
**Demo:** https://demo.example.com
## Screenshots ## Screenshots
![Screenshot of Example app](./doc/screenshots/example.jpg) ![Screenshot of Microbin](./doc/screenshots/screenshot7.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://microbin.eu/>
* Official user documentation: <https://yunohost.org/apps> - Upstream app code repository: <https://github.com/szabodanika/microbin>
* Official admin documentation: <https://yunohost.org/packaging_apps> - YunoHost Store: <https://apps.yunohost.org/app/microbin>
* Upstream app code repository: <https://some.forge.com/example/example> - Report a bug: <https://github.com/YunoHost-Apps/microbin_ynh/issues>
* YunoHost documentation for this app: <https://yunohost.org/app_example>
* Report a bug: <https://github.com/YunoHost-Apps/example_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/microbin_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/microbin_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 microbin -u https://github.com/YunoHost-Apps/microbin_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps> **More info regarding app packaging:** <https://yunohost.org/packaging_apps>

48
README_eu.md Normal file
View file

@ -0,0 +1,48 @@
<!--
Ohart ongi: README hau automatikoki sortu da <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>ri esker
EZ editatu eskuz.
-->
# Microbin YunoHost-erako
[![Integrazio maila](https://dash.yunohost.org/integration/microbin.svg)](https://dash.yunohost.org/appci/app/microbin) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/microbin.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/microbin.maintain.svg)
[![Instalatu Microbin YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=microbin)
*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)*
> *Pakete honek Microbin YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.*
> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.*
## Aurreikuspena
MicroBin is a super tiny, feature rich, configurable, self-contained and self-hosted paste bin web application. It is very easy to set up and use, and will only require a few megabytes of memory and disk storage. It takes only a couple minutes to set it up, why not give it a try now?
**Paketatutako bertsioa:** 2.0.4~ynh1
**Demoa:** <https://pub.microbin.eu/>
## Pantaila-argazkiak
![Microbin(r)en pantaila-argazkia](./doc/screenshots/screenshot7.png)
## Dokumentazioa eta baliabideak
- Aplikazioaren webgune ofiziala: <https://microbin.eu/>
- Jatorrizko aplikazioaren kode-gordailua: <https://github.com/szabodanika/microbin>
- YunoHost Denda: <https://apps.yunohost.org/app/microbin>
- Eman errore baten berri: <https://github.com/YunoHost-Apps/microbin_ynh/issues>
## Garatzaileentzako informazioa
Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/microbin_ynh/tree/testing).
`testing` abarra probatzeko, ondorengoa egin:
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/microbin_ynh/tree/testing --debug
edo
sudo yunohost app upgrade microbin -u https://github.com/YunoHost-Apps/microbin_ynh/tree/testing --debug
```
**Informazio gehiago aplikazioaren paketatzeari buruz:** <https://yunohost.org/packaging_apps>

73
README_fr.md
View file

@ -1,73 +1,48 @@
<!-- <!--
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 # Microbin 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/microbin.svg)](https://dash.yunohost.org/appci/app/microbin) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/microbin.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/microbin.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 Microbin avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=microbin)
> *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 Microbin 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 MicroBin est une application Web super petite, riche en fonctionnalités, configurable, autonome et auto-hébergée. Il est très simple à configurer et à utiliser et ne nécessitera que quelques mégaoctets de mémoire et de stockage sur disque. La configuration ne prend que quelques minutes, pourquoi ne pas l'essayer maintenant ?
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; **Version incluse :** 2.0.4~ynh1
- 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."
**Démo :** <https://pub.microbin.eu/>
**Version incluse :** 1.0~ynh1 ## Captures d’écran
**Démo :** https://demo.example.com ![Capture d’écran de Microbin](./doc/screenshots/screenshot7.png)
## Captures d'écran
![Capture d'écran de Example app](./doc/screenshots/example.jpg)
## 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://microbin.eu/>
* Documentation officielle utilisateur : <https://yunohost.org/apps> - Dépôt de code officiel de l’app : <https://github.com/szabodanika/microbin>
* Documentation officielle de l'admin : <https://yunohost.org/packaging_apps> - YunoHost Store : <https://apps.yunohost.org/app/microbin>
* Dépôt de code officiel de l'app : <https://some.forge.com/example/example> - Signaler un bug : <https://github.com/YunoHost-Apps/microbin_ynh/issues>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_example>
* Signaler un bug : <https://github.com/YunoHost-Apps/example_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/microbin_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/microbin_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 microbin -u https://github.com/YunoHost-Apps/microbin_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>

48
README_gl.md Normal file
View file

@ -0,0 +1,48 @@
<!--
NOTA: Este README foi creado automáticamente por <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
NON debe editarse manualmente.
-->
# Microbin para YunoHost
[![Nivel de integración](https://dash.yunohost.org/integration/microbin.svg)](https://dash.yunohost.org/appci/app/microbin) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/microbin.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/microbin.maintain.svg)
[![Instalar Microbin con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=microbin)
*[Le este README en outros idiomas.](./ALL_README.md)*
> *Este paquete permíteche instalar Microbin de xeito rápido e doado nun servidor YunoHost.*
> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.*
## Vista xeral
MicroBin is a super tiny, feature rich, configurable, self-contained and self-hosted paste bin web application. It is very easy to set up and use, and will only require a few megabytes of memory and disk storage. It takes only a couple minutes to set it up, why not give it a try now?
**Versión proporcionada:** 2.0.4~ynh1
**Demo:** <https://pub.microbin.eu/>
## Capturas de pantalla
![Captura de pantalla de Microbin](./doc/screenshots/screenshot7.png)
## Documentación e recursos
- Web oficial da app: <https://microbin.eu/>
- Repositorio de orixe do código: <https://github.com/szabodanika/microbin>
- Tenda YunoHost: <https://apps.yunohost.org/app/microbin>
- Informar dun problema: <https://github.com/YunoHost-Apps/microbin_ynh/issues>
## Info de desenvolvemento
Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/microbin_ynh/tree/testing).
Para probar a rama `testing`, procede deste xeito:
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/microbin_ynh/tree/testing --debug
ou
sudo yunohost app upgrade microbin -u https://github.com/YunoHost-Apps/microbin_ynh/tree/testing --debug
```
**Máis info sobre o empaquetado da app:** <https://yunohost.org/packaging_apps>