1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/helloworld_ynh.git synced 2024-09-03 19:15:57 +02:00

Add autogenerated README.md

This commit is contained in:
Alexandre Aubin 2023-01-11 10:00:20 +01:00
parent cbf9e94653
commit 3fe767f8ff
2 changed files with 71 additions and 3 deletions

View file

@ -1,5 +1,34 @@
# Hello World for Yunohost
# Hello World for YunoHost
Hello World is a basic dummy app to illustrate how YunoHost app packaging works.
[![Integration level](https://dash.yunohost.org/integration/helloworld.svg)](https://dash.yunohost.org/appci/app/helloworld) ![Working status](https://ci-apps.yunohost.org/ci/badges/helloworld.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/helloworld.maintain.svg)
[![Install Hello World with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=helloworld)
After installing the application, you can go to `your.domain.tld/helloworld` (or whichever page you chose) and you should see a simple page that shows 'Hello World!'
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Hello World 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
This app is only meant to be a minimalist app demontrating the v2 packaging format
**Shipped version:** 0.1~ynh1
## Documentation and resources
* YunoHost documentation for this app: <https://yunohost.org/app_helloworld>
* Report a bug: <https://github.com/YunoHost-Apps/helloworld_ynh/issues>
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/helloworld_ynh/tree/testing).
To try the testing branch, please proceed like that.
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/helloworld_ynh/tree/testing --debug
or
sudo yunohost app upgrade helloworld -u https://github.com/YunoHost-Apps/helloworld_ynh/tree/testing --debug
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>

39
README_fr.md Normal file
View file

@ -0,0 +1,39 @@
<!--
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.
-->
# Hello World pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/helloworld.svg)](https://dash.yunohost.org/appci/app/helloworld) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/helloworld.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/helloworld.maintain.svg)
[![Installer Hello World avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=helloworld)
*[Read this readme in english.](./README.md)*
> *Ce package vous permet d'installer Hello World 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
This app is only meant to be a minimalist app demontrating the v2 packaging format
**Version incluse :** 0.1~ynh1
## Documentations et ressources
* Documentation YunoHost pour cette app : <https://yunohost.org/app_helloworld>
* Signaler un bug : <https://github.com/YunoHost-Apps/helloworld_ynh/issues>
## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/helloworld_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit.
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/helloworld_ynh/tree/testing --debug
ou
sudo yunohost app upgrade helloworld -u https://github.com/YunoHost-Apps/helloworld_ynh/tree/testing --debug
```
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>