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

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2022-12-29 11:42:00 +00:00
parent 1dfa2abb60
commit f0b7e37317
2 changed files with 38 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
README.md
View file

@ -1,50 +1,38 @@
# 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)
* 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
It shall NOT be edited by hand.
-->
# Example app for YunoHost
# Libremdb 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)
[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
[![Integration level](https://dash.yunohost.org/integration/libremdb.svg)](https://dash.yunohost.org/appci/app/libremdb) ![Working status](https://ci-apps.yunohost.org/ci/badges/libremdb.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/libremdb.maintain.svg)
[![Install Libremdb with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=libremdb)
*[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 Libremdb 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.
A free & open source IMDb front-end.
### Features
- 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."
- Browse any movie info without being tracked or bombarded by annoying ads.
- Modern interface with curated colors supporting both dark and light themes.
- Be it your small mobile or big computer screen, it’s fully responsive.
- Lightweight
**Shipped version:** 1.0~ynh1
**Shipped version:** 2.2.2~ynh1
**Demo:** https://demo.example.com
## Screenshots
![Screenshot of Example app](./doc/screenshots/example.jpg)
![Screenshot of Libremdb](./doc/screenshots/screenshot.png)
## Disclaimers / important information
@ -63,23 +51,23 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
## Documentation and resources
* Official app website: <https://example.com>
* Official app website: <https://libremdb.iket.me/>
* 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>
* Upstream app code repository: <https://github.com/zyachel/libremdb>
* YunoHost documentation for this app: <https://yunohost.org/app_libremdb>
* Report a bug: <https://github.com/YunoHost-Apps/libremdb_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/libremdb_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/libremdb_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 libremdb -u https://github.com/YunoHost-Apps/libremdb_ynh/tree/testing --debug
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>

38
README_fr.md
View file

@ -3,36 +3,36 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
It shall NOT be edited by hand.
-->
# Exemple d'app pour YunoHost
# Libremdb 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)
[![Installer Example app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
[![Niveau d'intégration](https://dash.yunohost.org/integration/libremdb.svg)](https://dash.yunohost.org/appci/app/libremdb) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/libremdb.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/libremdb.maintain.svg)
[![Installer Libremdb avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=libremdb)
*[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 Libremdb 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.
A free & open source IMDb front-end.
### Features
- 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."
- Browse any movie info without being tracked or bombarded by annoying ads.
- Modern interface with curated colors supporting both dark and light themes.
- Be it your small mobile or big computer screen, it’s fully responsive.
- Lightweight
**Version incluse :** 1.0~ynh1
**Version incluse :** 2.2.2~ynh1
**Démo :** https://demo.example.com
## Captures d'écran
![Capture d'écran de Example app](./doc/screenshots/example.jpg)
![Capture d'écran de Libremdb](./doc/screenshots/screenshot.png)
## Avertissements / informations importantes
@ -51,23 +51,23 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
## Documentations et ressources
* Site officiel de l'app : <https://example.com>
* Site officiel de l'app : <https://libremdb.iket.me/>
* 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>
* Dépôt de code officiel de l'app : <https://github.com/zyachel/libremdb>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_libremdb>
* Signaler un bug : <https://github.com/YunoHost-Apps/libremdb_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/libremdb_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/libremdb_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 libremdb -u https://github.com/YunoHost-Apps/libremdb_ynh/tree/testing --debug
```
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>