From 12103538c74e34ec0651908bff5c65fb1ec2d8a5 Mon Sep 17 00:00:00 2001 From: Maniack Crudelis Date: Fri, 3 Feb 2017 21:12:24 +0100 Subject: [PATCH 1/5] [enh] Update readme MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squelette de readme, pour éviter des readme sans infos. --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6d6cb13..6b07f27 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,25 @@ -# YunoHost example app +Example app for YunoHost +================== + +[Yunohost project](https://yunohost.org/#/) + +Small description of the app + +https://example.com ## Usage -- Add application source files into `sources` subfolder. +- Fork this app before work on it. +- Edit the source files into `sources` subfolder. - Edit `conf/nginx.conf` file to match application prerequisites. - Edit manifest with application specific information. - Edit the install, upgrade, remove, backup, restore scripts. - Add a LICENSE file for the package. +- Edit this readme. **More information on the documentation page:** https://yunohost.org/packaging_apps + +**Upgrade this package:** +sudo yunohost app upgrade --verbose example -u https://github.com/YunoHost-Apps/example_ynh + +**Multi-user:** Yes/No. How about the ldap and HTTP auth support. From 7a8c0d9e001857635b94abab6630238a7012188c Mon Sep 17 00:00:00 2001 From: Moul Date: Sat, 4 Feb 2017 09:58:08 +0100 Subject: [PATCH 2/5] [enh] markdown syntax. --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6b07f27..b6da462 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@ -Example app for YunoHost -================== +# Example app for YunoHost -[Yunohost project](https://yunohost.org/#/) +- [Yunohost project](https://yunohost.org) +- [Exemple app website](https://example.com) -Small description of the app - -https://example.com +Description of the app. ## Usage - Fork this app before work on it. @@ -13,13 +11,13 @@ https://example.com - Edit `conf/nginx.conf` file to match application prerequisites. - Edit manifest with application specific information. - Edit the install, upgrade, remove, backup, restore scripts. -- Add a LICENSE file for the package. +- Add a `LICENSE` file for the package. - Edit this readme. **More information on the documentation page:** https://yunohost.org/packaging_apps **Upgrade this package:** -sudo yunohost app upgrade --verbose example -u https://github.com/YunoHost-Apps/example_ynh +`sudo yunohost app upgrade --verbose example -u https://github.com/YunoHost-Apps/example_ynh` **Multi-user:** Yes/No. How about the ldap and HTTP auth support. From fae053782e4b39bcf5084fd6d028f1202c8d735e Mon Sep 17 00:00:00 2001 From: Moul Date: Sat, 4 Feb 2017 09:59:17 +0100 Subject: [PATCH 3/5] [mod] remove 'sources' file as it's a non recommended way to manage sources. --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index b6da462..a4273eb 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,6 @@ Description of the app. ## Usage - Fork this app before work on it. -- Edit the source files into `sources` subfolder. - Edit `conf/nginx.conf` file to match application prerequisites. - Edit manifest with application specific information. - Edit the install, upgrade, remove, backup, restore scripts. From d1f507116e6935fcfa72a25558228810ab762cfe Mon Sep 17 00:00:00 2001 From: Moul Date: Sat, 4 Feb 2017 10:01:11 +0100 Subject: [PATCH 4/5] [mod] markdown syntax. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a4273eb..aab5d73 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,10 @@ Description of the app. ## Usage - Fork this app before work on it. - Edit `conf/nginx.conf` file to match application prerequisites. -- Edit manifest with application specific information. -- Edit the install, upgrade, remove, backup, restore scripts. +- Edit `manifest.json` with application specific information. +- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts. - Add a `LICENSE` file for the package. -- Edit this readme. +- Edit `README.md`. **More information on the documentation page:** https://yunohost.org/packaging_apps From 5ae7d82535d4d6e20c1df4973013ea144437a5e5 Mon Sep 17 00:00:00 2001 From: Moul Date: Sat, 4 Feb 2017 10:02:28 +0100 Subject: [PATCH 5/5] [enh] fork isn't the good way as the git repo will starts with commits from example_ynh. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index aab5d73..40e7524 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Description of the app. ## Usage -- Fork this app before work on it. +- Copy this app before work on it. - Edit `conf/nginx.conf` file to match application prerequisites. - Edit `manifest.json` with application specific information. - Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts.