qr_ynh/README.md

<!--
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.
-->

# LibreQR for YunoHost

[![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)

[![Install LibreQR with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=qr)

*[Lire ce readme en français.](./README_fr.md)*

> *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.*

## Overview

A PHP Web interface for generating QR codes. You can choose colors, size and redundancy rate.


**Shipped version:** 2.0.1~ynh1

**Demo:** https://qr.antopie.org

## Screenshots

![Screenshot of LibreQR](./doc/screenshots/screenshot.png)

## Documentation and resources

* Upstream app code repository: <https://code.antopie.org/miraty/libreqr>
* YunoHost documentation for this app: <https://yunohost.org/app_qr>
* Report a bug: <https://code.antopie.org/miraty/qr_ynh/issues>

## Developer info

Please send your pull request to the [testing branch](https://code.antopie.org/miraty/qr_ynh/src/branch/testing).

To try the testing branch, please proceed like that.

``` bash
sudo yunohost app install https://code.antopie.org/miraty/qr_ynh/tree/testing --debug
or
sudo yunohost app upgrade qr -u https://code.antopie.org/miraty/qr_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>