From baf9e0dd0c15cd204826f01b8c98b7ac5204b009 Mon Sep 17 00:00:00 2001
From: Alexandre Aubin <alex.aubin@mailoo.org>
Date: Mon, 10 May 2021 17:23:40 +0200
Subject: [PATCH] Misc tweaks

---
 {READMEs => README-generator}/make_readme.py  |  2 ++
 .../requirements.txt                          |  0
 .../templates/README.md.j2                    | 19 +++++++++++++++++++
 .../templates/README_fr.md.j2                 |  0
 4 files changed, 21 insertions(+)
 rename {READMEs => README-generator}/make_readme.py (98%)
 mode change 100644 => 100755
 rename {READMEs => README-generator}/requirements.txt (100%)
 rename {READMEs => README-generator}/templates/README.md.j2 (71%)
 rename {READMEs => README-generator}/templates/README_fr.md.j2 (100%)

diff --git a/READMEs/make_readme.py b/README-generator/make_readme.py
old mode 100644
new mode 100755
similarity index 98%
rename from READMEs/make_readme.py
rename to README-generator/make_readme.py
index 63dc8cb..ffbc8f4
--- a/READMEs/make_readme.py
+++ b/README-generator/make_readme.py
@@ -1,3 +1,5 @@
+#! /usr/bin/python3
+
 import argparse
 import json
 import os
diff --git a/READMEs/requirements.txt b/README-generator/requirements.txt
similarity index 100%
rename from READMEs/requirements.txt
rename to README-generator/requirements.txt
diff --git a/READMEs/templates/README.md.j2 b/README-generator/templates/README.md.j2
similarity index 71%
rename from READMEs/templates/README.md.j2
rename to README-generator/templates/README.md.j2
index b8bda14..f368039 100644
--- a/READMEs/templates/README.md.j2
+++ b/README-generator/templates/README.md.j2
@@ -1,3 +1,22 @@
+{% if manifest.id == "example" %}
+# Packaging your an app, starting from this example
+
+- Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
+- Edit the `manifest.json` with app specific info.
+- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
+  - Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
+- Add a `LICENSE` file for the package.
+- Edit `doc/DISCLAIMER*.md`
+- The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
+{% endif %}
+
+---
+
+<!--
+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.
+-->
+
 # {{manifest.name}} for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/{{manifest.id}}.svg)](https://dash.yunohost.org/appci/app/{{manifest.id}}) ![](https://ci-apps.yunohost.org/ci/badges/{{manifest.id}}.status.svg)  ![](https://ci-apps.yunohost.org/ci/badges/{{manifest.id}}.maintain.svg)
diff --git a/READMEs/templates/README_fr.md.j2 b/README-generator/templates/README_fr.md.j2
similarity index 100%
rename from READMEs/templates/README_fr.md.j2
rename to README-generator/templates/README_fr.md.j2