qr_ynh/README.md

49 lines
1.8 KiB
Markdown
Raw Normal View History

2022-03-03 17:58:37 +01:00
<!--
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.
-->
2020-10-31 19:55:37 +01:00
# LibreQR for YunoHost
2019-08-13 21:35:51 +02:00
2022-06-02 00:44:51 +02:00
[![Integration level](https://dash.yunohost.org/integration/qr.svg)](https://dash.yunohost.org/appci/app/qr) ![Working status](https://ci-apps.yunohost.org/ci/badges/qr.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/qr.maintain.svg)
2022-03-03 17:58:37 +01:00
[![Install LibreQR with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=qr)
2019-08-13 21:35:51 +02:00
2020-10-31 19:55:37 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2019-08-13 21:35:51 +02:00
2020-10-31 19:55:37 +01:00
> *This package allows you to install LibreQR 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.*
2019-08-15 21:51:02 +02:00
2020-10-31 19:55:37 +01:00
## Overview
2019-08-13 21:35:51 +02:00
2022-03-03 17:58:37 +01:00
Web interface for generating QR codes
2019-08-13 21:35:51 +02:00
2022-08-27 02:51:58 +02:00
**Shipped version:** 2.0.0~ynh2
2019-08-13 21:35:51 +02:00
2022-03-03 17:58:37 +01:00
**Demo:** https://qr.antopie.org
2019-08-15 21:51:02 +02:00
2022-03-03 17:58:37 +01:00
## Screenshots
2019-08-15 21:51:02 +02:00
2022-06-02 00:44:51 +02:00
![Screenshot of LibreQR](./doc/screenshots/screenshot.png)
2019-08-15 21:51:02 +02:00
2022-03-03 17:58:37 +01:00
## Documentation and resources
2019-08-15 21:51:02 +02:00
2022-08-27 02:51:58 +02:00
* Official app website: <https://code.antopie.org/miraty/libreqr>
2022-06-02 00:44:51 +02:00
* Upstream app code repository: <https://code.antopie.org/miraty/libreqr>
* YunoHost documentation for this app: <https://yunohost.org/app_qr>
2022-06-07 20:33:19 +02:00
* Report a bug: <https://code.antopie.org/miraty/qr_ynh/issues>
2019-08-17 17:58:11 +02:00
2022-03-03 17:58:37 +01:00
## Developer info
2022-03-03 17:58:37 +01:00
Please send your pull request to the [testing branch](https://code.antopie.org/miraty/qr_ynh/src/branch/testing).
2022-03-03 17:58:37 +01:00
To try the testing branch, please proceed like that.
2022-06-02 00:44:51 +02:00
``` bash
2022-06-07 20:33:19 +02:00
sudo yunohost app install https://code.antopie.org/miraty/qr_ynh/tree/testing --debug
2022-03-03 17:58:37 +01:00
or
2022-06-07 20:33:19 +02:00
sudo yunohost app upgrade qr -u https://code.antopie.org/miraty/qr_ynh/tree/testing --debug
2022-03-03 17:58:37 +01:00
```
2020-03-23 18:32:36 +01:00
2022-06-02 00:44:51 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>