Merge pull request #32 from YunoHost-Apps/Add-readme-templates

Add readme templates

README.md

@@ -1,3 +1,8 @@
+<!--
+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.
+-->
+
 # Hextris for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/hextris.svg)](https://dash.yunohost.org/appci/app/hextris) ![](https://ci-apps.yunohost.org/ci/badges/hextris.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/hextris.maintain.svg)  
@@ -5,44 +10,29 @@
 
 *[Lire ce readme en français.](./README_fr.md)*
 
-*[Lire ce readme en français.](./README_fr.md)*
+> *This package allows you to install Hextris quickly and simply on a YunoHost server.
-
-> *This package allows you to install Hextris 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
-An addictive puzzle game inspired by Tetris.
 
-**Shipped version:** 2020-05-05
+Rotate the Hexagon to prevent the blocks from stacking outside the outer grey hexagon!
+
+HEXTRIS is a fast paced puzzle game inspired by Tetris. Blocks start on the edges of the screen, and fall towards the inner blue hexagon. The objective of the game is to prevent the blocks from stacking outside the area of the grey hexagon. To do this, you must rotate the hexagon to manage different stacks of blocks on each face. Aim to connect 3 or more blocks of the same color: when 3 or more blocks of the same color touch each other, they are destroyed, and the blocks above them slide down! Destroying multiple series of blocks grants combos, whose durations are indicated by a quickly receding outline around the outer, grey hexagon. You lose once blocks on a face of the hexagon stack outside of the outer hexagon!
+
+**Shipped version:** 2020-05-05~ynh4
+
+**Demo:** https://hextris.io/
 
 ## Screenshots
 
-![](https://raw.githubusercontent.com/YunoHost-Apps/hextris_ynh/master/screenshot.jpg)
+![](./doc/screenshots/screenshot.jpg)
 
-## Demo
+## Documentation and resources
 
-* [Official demo](http://hextris.io/)
+* Official app website: http://hextris.github.io/
-* [YunoHost demo](https://demo.yunohost.org/hextris/)
+* Upstream app code repository: https://github.com/Hextris/Hextris
-
+* YunoHost documentation for this app: https://yunohost.org/app_hextris
-## Documentation
+* Report a bug: https://github.com/YunoHost-Apps/hextris_ynh/issues
-
- * Official documentation: https://github.com/Hextris/Hextris
- * YunoHost documentation: https://yunohost.org/en/app_hextris
-
-
-#### Supported architectures
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/hextris.svg)](https://ci-apps.yunohost.org/ci/apps/hextris/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/hextris.svg)](https://ci-apps-arm.yunohost.org/ci/apps/hextris/)
-
-## Links
-
- * Report a bug: https://github.com/YunoHost-Apps/hextris_ynh/issues
- * Hextris website: http://hextris.github.io/
- * Upstream app repository: https://github.com/Hextris/Hextris
- * YunoHost website: https://yunohost.org/
-
----
 
 ## Developer info
 
@@ -54,3 +44,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/hextris_ynh/tree/test
 or
 sudo yunohost app upgrade hextris -u https://github.com/YunoHost-Apps/hextris_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -3,44 +3,32 @@
 [![Niveau d'intégration](https://dash.yunohost.org/integration/hextris.svg)](https://dash.yunohost.org/appci/app/hextris) ![](https://ci-apps.yunohost.org/ci/badges/hextris.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/hextris.maintain.svg)  
 [![Installer Hextris avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hextris)
 
-*[Read this readme in english.](./README.md)* 
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
 
-> *Ce package vous permet d'installer Hextris rapidement et simplement sur un serveur YunoHost.  
+> *Ce package vous permet d'installer Hextris rapidement et simplement sur un serveur YunoHost.
-Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.*
+Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
 
 ## Vue d'ensemble
-Un puzzle addictif inspiré de Tetris.
 
-**Version incluse :** 2020-05-05
+Rotate the Hexagon to prevent the blocks from stacking outside the outer grey hexagon!
+
+HEXTRIS is a fast paced puzzle game inspired by Tetris. Blocks start on the edges of the screen, and fall towards the inner blue hexagon. The objective of the game is to prevent the blocks from stacking outside the area of the grey hexagon. To do this, you must rotate the hexagon to manage different stacks of blocks on each face. Aim to connect 3 or more blocks of the same color: when 3 or more blocks of the same color touch each other, they are destroyed, and the blocks above them slide down! Destroying multiple series of blocks grants combos, whose durations are indicated by a quickly receding outline around the outer, grey hexagon. You lose once blocks on a face of the hexagon stack outside of the outer hexagon!
+
+**Version incluse :** 2020-05-05~ynh4
+
+**Démo :** https://hextris.io/
 
 ## Captures d'écran
 
-![](https://raw.githubusercontent.com/YunoHost-Apps/hextris_ynh/master/screenshot.jpg)
+![](./doc/screenshots/screenshot.jpg)
 
-## Démo
+## Documentations et ressources
 
-* [Démo officielle](http://hextris.io/)
+* Site officiel de l'app : http://hextris.github.io/
-* [Démo YunoHost](https://demo.yunohost.org/hextris/)
+* Dépôt de code officiel de l'app : https://github.com/Hextris/Hextris
-
+* Documentation YunoHost pour cette app : https://yunohost.org/app_hextris
-## Documentation
+* Signaler un bug : https://github.com/YunoHost-Apps/hextris_ynh/issues
-
- * Documentation officielle : https://github.com/Hextris/Hextris
- * Documentation YunoHost : https://yunohost.org/fr/app_hextris
-
-
-#### Architectures supportées
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/hextris.svg)](https://ci-apps.yunohost.org/ci/apps/hextris/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/hextris.svg)](https://ci-apps-arm.yunohost.org/ci/apps/hextris/)
-
-## Liens
-
- * Signaler un bug : https://github.com/YunoHost-Apps/hextris_ynh/issues
- * Site de l'application : http://hextris.github.io/
- * Dépôt de l'application principale : https://github.com/Hextris/Hextris
- * Site web YunoHost : https://yunohost.org/
-
----
 
 ## Informations pour les développeurs
 
@@ -52,3 +40,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/hextris_ynh/tree/test
 ou
 sudo yunohost app upgrade hextris -u https://github.com/YunoHost-Apps/hextris_ynh/tree/testing --debug
 ```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps

check_process

@@ -1,8 +1,8 @@
 ;; Test complet
 	; Manifest
-		domain="domain.tld"	(DOMAIN)
+		domain="domain.tld"
-		path="/path"	(PATH)
+		path="/path"
-		is_public=1	(PUBLIC|public=1|private=0)
+		is_public=1
 	; Checks
 		pkg_linter=1
 		setup_sub_dir=1

doc/DESCRIPTION.md

@@ -0,0 +1,3 @@
+Rotate the Hexagon to prevent the blocks from stacking outside the outer grey hexagon!
+
+HEXTRIS is a fast paced puzzle game inspired by Tetris. Blocks start on the edges of the screen, and fall towards the inner blue hexagon. The objective of the game is to prevent the blocks from stacking outside the area of the grey hexagon. To do this, you must rotate the hexagon to manage different stacks of blocks on each face. Aim to connect 3 or more blocks of the same color: when 3 or more blocks of the same color touch each other, they are destroyed, and the blocks above them slide down! Destroying multiple series of blocks grants combos, whose durations are indicated by a quickly receding outline around the outer, grey hexagon. You lose once blocks on a face of the hexagon stack outside of the outer hexagon!

manifest.json

@@ -3,18 +3,24 @@
     "id": "hextris",
     "packaging_format": 1,
     "description": {
-        "en": "A fast paced puzzle game.",
+        "en": "A fast paced puzzle game",
         "fr": "Un jeu de puzzle très rapide"
     },
-    "version": "2020-05-05~ynh3",
+    "version": "2020-05-05~ynh4",
     "url": "http://hextris.github.io/",
+    "upstream": {
+        "license": "GPL-3.0",
+        "website": "http://hextris.github.io/",
+        "demo": "https://hextris.io/",
+        "code": "https://github.com/Hextris/Hextris"
+    },
     "license": "GPL-3.0",
     "maintainer": {
         "name": "AerisOne",
         "email": "aeris@e.email"
     },
     "requirements": {
-        "yunohost": ">= 4.1.7"
+        "yunohost": ">= 4.2.4"
     },
     "multi_instance": true,
     "services": [