Mise à jour du README
This commit is contained in:
parent
9318c5e441
commit
7a093ac4a5
86
README.md
86
README.md
|
@ -1,86 +1,36 @@
|
||||||
# Usage of this package (REMOVE THIS SECTION BEFORE RELEASE)
|
# Générateur de codes QR pour YunoHost
|
||||||
- Copy this app before working on it.
|
|
||||||
- Edit `conf/nginx.conf` file to match application prerequisites.
|
|
||||||
- Edit `manifest.json` with application specific information.
|
|
||||||
- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts.
|
|
||||||
- Using the [script helpers documentation.](https://helpers.yunohost.org/)
|
|
||||||
- Add a `LICENSE` file for the package.
|
|
||||||
- Edit `README.md` and README_fr.md.
|
|
||||||
|
|
||||||
# Example app for YunoHost
|
|
||||||
|
|
||||||
[![Integration level](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP)
|
[![Integration level](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP)
|
||||||
[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP)
|
[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP)
|
||||||
|
|
||||||
*[Lire ce readme en français.](./README_fr.md)*
|
> *Ce package vous permet d'installer un Générateur de codes QR 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.*
|
||||||
|
|
||||||
> *This package allow you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server.
|
## Vue d'ensemble
|
||||||
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
|
Un interface Web en PHP pour générer des codes QR.
|
||||||
|
Fonctionne même sans JavaScript.
|
||||||
|
|
||||||
## Overview
|
**Version incluse:** 1.1.0
|
||||||
Quick description of this app.
|
|
||||||
|
|
||||||
**Shipped version:** 1.0
|
## Capture d'écran
|
||||||
|
|
||||||
## Screenshots
|
![](screenshot.png)
|
||||||
|
|
||||||
![](Link to an screenshot for this app)
|
## Démo
|
||||||
|
|
||||||
## Demo
|
* [Démo officielle](https://qr.antopie.org)
|
||||||
|
|
||||||
* [Official demo](Link to a demo site for this app)
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
How to configure this app: by an admin panel, a plain file with SSH, or any other way.
|
Modifiez le fichier /var/www/qr/options.inc.php à votre guise
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
* Official documentation: Link to the official documentation of this app
|
Aucune pour l'instant
|
||||||
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
|
|
||||||
|
|
||||||
## YunoHost specific features
|
## Liens
|
||||||
|
|
||||||
#### Multi-users support
|
* Signaler un bug dans le paquet YunoHost : https://code.antopie.org/miraty/qr_ynh/issues
|
||||||
|
* Signaler un bug dans le logiciel source : https://code.antopie.org/miraty/qr/issues
|
||||||
Are LDAP and HTTP auth supported?
|
* Dépôt de l'application principale : https://code.antopie.org/miraty/qr/
|
||||||
Can the app be used by multiple users?
|
* Site web de YunoHost : https://yunohost.org/
|
||||||
|
|
||||||
#### Supported architectures
|
|
||||||
|
|
||||||
* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
|
|
||||||
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
|
|
||||||
* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/REPLACEBYYOURAPP/)
|
|
||||||
|
|
||||||
## Limitations
|
|
||||||
|
|
||||||
* Any known limitations.
|
|
||||||
|
|
||||||
## Additional information
|
|
||||||
|
|
||||||
* Other information you would add about this application
|
|
||||||
|
|
||||||
**More information on the documentation page:**
|
|
||||||
https://yunohost.org/packaging_apps
|
|
||||||
|
|
||||||
## Links
|
|
||||||
|
|
||||||
* Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
|
|
||||||
* App website: Link to the official website of this app
|
|
||||||
* Upstream app repository: Link to the official repository of the upstream app
|
|
||||||
* YunoHost website: https://yunohost.org/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Developers info
|
|
||||||
----------------
|
|
||||||
|
|
||||||
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
|
|
||||||
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing).
|
|
||||||
|
|
||||||
To try the testing branch, please proceed like that.
|
|
||||||
```
|
|
||||||
sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
|
|
||||||
or
|
|
||||||
sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
|
|
||||||
```
|
|
||||||
|
|
Binary file not shown.
After Width: | Height: | Size: 42 KiB |
Loading…
Reference in New Issue