automatically generated

README.md

@@ -1,3 +1,52 @@
-# sr2ini_yhn
+<!--
+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.
+-->
 
-sr2ini as a Yunohost package.
+# SR2 Initiative Tracker for YunoHost
+
+[![Integration level](https://dash.yunohost.org/integration/sr2ini.svg)](https://dash.yunohost.org/appci/app/sr2ini) ![Working status](https://ci-apps.yunohost.org/ci/badges/sr2ini.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/sr2ini.maintain.svg)
+
+[![Install SR2 Initiative Tracker with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=sr2ini)
+
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *This package allows you to install SR2 Initiative Tracker 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
+
+sr2ini is a lightweight, single-page initiative tracker for the TTRPG Shadowrun in its 2nd edition. The app helps DMs and players to manage fights by tracking each combatant's initiative, order of action, damage (stun and physical), and wound modifiers. It was written specifically for mobile use and can be installed as a web app.
+
+This package allows you to install sr2ini quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.
+
+## YunoHost specific features
+
+  * supports multi-install
+  * defaut visibility is public
+
+
+**Shipped version:** 0.9~ynh1
+
+## Screenshots
+
+![Screenshot of SR2 Initiative Tracker](./doc/screenshots/sr2ini-screenshot.jpg)
+
+## Documentation and resources
+
+* YunoHost documentation for this app: <https://yunohost.org/app_sr2ini>
+* Report a bug: <https://github.com/YunoHost-Apps/sr2ini_ynh/issues>
+
+## Developer info
+
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/sr2ini_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+
+``` bash
+sudo yunohost app install https://github.com/YunoHost-Apps/sr2ini_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade sr2ini -u https://github.com/YunoHost-Apps/sr2ini_ynh/tree/testing --debug
+```
+
+**More info regarding app packaging:** <https://yunohost.org/packaging_apps>

README_fr.md

@@ -0,0 +1,52 @@
+<!--
+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.
+-->
+
+# SR2 Initiative Tracker pour YunoHost
+
+[![Niveau d’intégration](https://dash.yunohost.org/integration/sr2ini.svg)](https://dash.yunohost.org/appci/app/sr2ini) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/sr2ini.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/sr2ini.maintain.svg)
+
+[![Installer SR2 Initiative Tracker avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=sr2ini)
+
+*[Read this readme in english.](./README.md)*
+
+> *Ce package vous permet d’installer SR2 Initiative Tracker 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
+
+sr2ini is a lightweight, single-page initiative tracker for the TTRPG Shadowrun in its 2nd edition. The app helps DMs and players to manage fights by tracking each combatant's initiative, order of action, damage (stun and physical), and wound modifiers. It was written specifically for mobile use and can be installed as a web app.
+
+This package allows you to install sr2ini quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.
+
+## YunoHost specific features
+
+  * supports multi-install
+  * defaut visibility is public
+
+
+**Version incluse :** 0.9~ynh1
+
+## Captures d’écran
+
+![Capture d’écran de SR2 Initiative Tracker](./doc/screenshots/sr2ini-screenshot.jpg)
+
+## Documentations et ressources
+
+* Documentation YunoHost pour cette app : <https://yunohost.org/app_sr2ini>
+* Signaler un bug : <https://github.com/YunoHost-Apps/sr2ini_ynh/issues>
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/sr2ini_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+
+``` bash
+sudo yunohost app install https://github.com/YunoHost-Apps/sr2ini_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade sr2ini -u https://github.com/YunoHost-Apps/sr2ini_ynh/tree/testing --debug
+```
+
+**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>