qrcode.chapril.org/README.md

69 lines
2.9 KiB
Markdown
Raw Normal View History

2019-08-14 17:12:36 +02:00
# ![Logo](themes/defaut/favicons/32.png) Générateur de codes QR
2019-08-13 21:17:08 +02:00
## Présentation
Une interface Web pour générer des codes QR en PHP.
## Démo
2019-01-26 15:17:36 +01:00
Une instance de ce service est disponible à l'adresse [https://qr.antopie.org](https://qr.antopie.org).
2019-08-13 21:17:08 +02:00
2019-08-14 17:12:36 +02:00
## Fonctionnement
Le Générateur de codes QR inclus un plugin [OpenSearch](https://developer.mozilla.org/docs/Web/OpenSearch), ce qui permet de l'ajouter comme moteur de recherche dans Firefox.
Vous pouvez ainsi générer un code QR directement depuis la barre de recherche.
Un [WebManifest](https://developer.mozilla.org/docs/Web/Manifest) est également inclus, ce qui permet de mieux l'intégrer au système via Fennec (Firefox Android) ou Chromium.
2019-08-13 21:17:08 +02:00
## Installation
2019-08-14 17:12:36 +02:00
### Générique
Je développe directement dans master, donc en production téléchargez plutôt une version stable dans [l'onglet Versions](https://code.antopie.org/miraty/qr/releases).
2019-08-13 21:17:08 +02:00
Placez ce code source dans un serveur Web avec PHP, tout simplement.
2019-08-14 17:12:36 +02:00
### YunoHost
J'ai créé un [paquet](https://code.antopie.org/miraty/qr_ynh/) [YunoHost](https://yunohost.org/).
```
sudo yunohost app install https://code.antopie.org/miraty/qr_ynh/
```
2019-08-13 21:17:08 +02:00
## Thèmes
### Changer de thème
Dans options.inc.php, donnez à $theme le nom du thème voulu.
Par défaut, deux thèmes sont proposés :
* defaut, le thème par défaut, sombre. Il est utilisé ici : <https://qr.antopie.org>
* parinux, un thème bleu, créé pour [Bastet](https://bastet.parinux.org/), le chaton de [Parinux](https://parinux.org/). Il est utilisé ici : <https://qrcode.parinux.org>
### Créer un thème
* Copiez themes/defaut vers themes/[nom de votre thème]
* Depuis ce nouveau dossier, créez les icônes dans favicons/[longueur du côté de l'icone].png
2019-08-14 17:12:36 +02:00
* Complétez theme.php en fonctions des favicons créées précédemment et des couleurs CSS voulues dans l'interface
2019-08-13 21:17:08 +02:00
## Bibliothèques tierces
Ce code source inclus :
* [phpqrcode](https://github.com/t0k4rt/phpqrcode) pour générer les codes QR
* [La police Ubuntu packagée pour le Web](https://github.com/earaujoassis/ubuntu-fontface)
* [lessphp](http://leafo.net/lessphp) pour compiler le [Less](http://lesscss.org/)
## Licence
[AGPLv3+](https://code.antopie.org/miraty/qr/src/branch/master/LICENSE)
Ce générateur de codes QR est un logiciel libre ; vous pouvez le diffuser et le modifier suivant les termes de la GNU Affero General Public License telle que publiée par la Free Software Foundation ; soit la version 3 de cette licence, soit (à votre convenance) une version ultérieure.
Ce générateur de codes QR est diffusé dans lespoir quil sera utile, mais SANS AUCUNE GARANTIE ; sans même une garantie implicite de COMMERCIALISATION ou dADÉQUATION À UN USAGE PARTICULIER. Voyez la GNU Affero General Public License pour plus de détails.
Vous devriez avoir reçu une copie de la GNU Affero General Public License avec ce code. Sinon, consultez <https://www.gnu.org/licenses/>