From b073c4f9474228badcb99fe1d4cfdc50975785fc Mon Sep 17 00:00:00 2001 From: Carmen Bianca BAKKER Date: Mon, 14 Oct 2024 12:02:43 +0200 Subject: [PATCH 1/3] Add CONTEXT.rst to list of files Signed-off-by: Carmen Bianca BAKKER --- template/module/README.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/template/module/README.rst b/template/module/README.rst index 38929e877..273acbe84 100644 --- a/template/module/README.rst +++ b/template/module/README.rst @@ -5,6 +5,7 @@ Please provide content in the ``readme`` directory: * **DESCRIPTION.rst** (required) +* **CONTEXT.rst** (optional, highly recommended) * INSTALL.rst (optional) * CONFIGURE.rst (optional) * **USAGE.rst** (optional, highly recommended) From 886047f0da7fac514bdbacb5bbde255265757eb8 Mon Sep 17 00:00:00 2001 From: Carmen Bianca BAKKER Date: Mon, 14 Oct 2024 12:04:14 +0200 Subject: [PATCH 2/3] Fix the order of readme files This is in line with the order in gen_addon_readme.py. Signed-off-by: Carmen Bianca BAKKER --- template/module/README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/template/module/README.rst b/template/module/README.rst index 273acbe84..4b4da6ab0 100644 --- a/template/module/README.rst +++ b/template/module/README.rst @@ -9,11 +9,11 @@ Please provide content in the ``readme`` directory: * INSTALL.rst (optional) * CONFIGURE.rst (optional) * **USAGE.rst** (optional, highly recommended) -* DEVELOP.rst (optional) * ROADMAP.rst (optional) -* HISTORY.rst (optional, recommended) +* DEVELOP.rst (optional) * **CONTRIBUTORS.rst** (optional, highly recommended) * CREDITS.rst (optional) +* HISTORY.rst (optional, recommended) Content of this README will also be drawn from the addon manifest, from keys such as name, authors, maintainers, development_status, From dc9127c991edd9147396386ab677e66cee969b77 Mon Sep 17 00:00:00 2001 From: Carmen Bianca BAKKER Date: Mon, 14 Oct 2024 12:05:44 +0200 Subject: [PATCH 3/3] Add documentation for ability to use Markdown Signed-off-by: Carmen Bianca BAKKER --- template/module/README.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/template/module/README.rst b/template/module/README.rst index 4b4da6ab0..57c3b16ea 100644 --- a/template/module/README.rst +++ b/template/module/README.rst @@ -15,6 +15,9 @@ Please provide content in the ``readme`` directory: * CREDITS.rst (optional) * HISTORY.rst (optional, recommended) +Instead of using reStructuredText (``.rst``), you may use Markdown (``.md``) to +format your files. + Content of this README will also be drawn from the addon manifest, from keys such as name, authors, maintainers, development_status, and license.