diff --git a/template/module/readme/CONFIGURE.rst b/template/module/readme/CONFIGURE.md similarity index 60% rename from template/module/readme/CONFIGURE.rst rename to template/module/readme/CONFIGURE.md index 754e51aef..c8fad610f 100644 --- a/template/module/readme/CONFIGURE.rst +++ b/template/module/readme/CONFIGURE.md @@ -3,8 +3,6 @@ To configure this module, you need to: -#. Go to ... +- Go to ... -.. figure:: ../static/description/image.png - :alt: alternative description - :width: 600 px +![alternative description]()../static/description/image.png) diff --git a/template/module/readme/CONTEXT.rst b/template/module/readme/CONTEXT.md similarity index 100% rename from template/module/readme/CONTEXT.rst rename to template/module/readme/CONTEXT.md diff --git a/template/module/readme/CONTRIBUTORS.md b/template/module/readme/CONTRIBUTORS.md new file mode 100644 index 000000000..7be72fb96 --- /dev/null +++ b/template/module/readme/CONTRIBUTORS.md @@ -0,0 +1,2 @@ +- Firstname Lastname (optional company website url) +- Second Person (optional company website url) diff --git a/template/module/readme/CONTRIBUTORS.rst b/template/module/readme/CONTRIBUTORS.rst deleted file mode 100644 index 786f0d6dc..000000000 --- a/template/module/readme/CONTRIBUTORS.rst +++ /dev/null @@ -1,2 +0,0 @@ -* Firstname Lastname (optional company website url) -* Second Person (optional company website url) diff --git a/template/module/readme/CREDITS.rst b/template/module/readme/CREDITS.md similarity index 84% rename from template/module/readme/CREDITS.rst rename to template/module/readme/CREDITS.md index 505af5aae..9c2b025b5 100644 --- a/template/module/readme/CREDITS.rst +++ b/template/module/readme/CREDITS.md @@ -3,5 +3,5 @@ The development of this module has been financially supported by: -* Company 1 name -* Company 2 name +- Company 1 name +- Company 2 name diff --git a/template/module/readme/DESCRIPTION.rst b/template/module/readme/DESCRIPTION.md similarity index 100% rename from template/module/readme/DESCRIPTION.rst rename to template/module/readme/DESCRIPTION.md diff --git a/template/module/readme/HISTORY.rst b/template/module/readme/HISTORY.md similarity index 58% rename from template/module/readme/HISTORY.rst rename to template/module/readme/HISTORY.md index ac1f5b674..a6daf58cc 100644 --- a/template/module/readme/HISTORY.rst +++ b/template/module/readme/HISTORY.md @@ -8,17 +8,15 @@ forbidden and will likely break the structure of the README.rst or other documents where this fragment is included. ] -11.0.x.y.z (YYYY-MM-DD) -~~~~~~~~~~~~~~~~~~~~~~~ +## 11.0.x.y.z (YYYY-MM-DD) -* [BREAKING] Breaking changes come first. - (`#70 `_) -* [ADD] New feature. - (`#74 `_) -* [FIX] Correct this. - (`#71 `_) +- [BREAKING] Breaking changes come first. + ([#70](https://github.com/OCA/repo/issues/70)) +- [ADD] New feature. + ([#74](https://github.com/OCA/repo/issues/74)) +- [FIX] Correct this. + ([#71](https://github.com/OCA/repo/issues/71)) -11.0.x.y.z (YYYY-MM-DD) -~~~~~~~~~~~~~~~~~~~~~~~ +## 11.0.x.y.z (YYYY-MM-DD) -* ... +- ... diff --git a/template/module/readme/INSTALL.rst b/template/module/readme/INSTALL.md similarity index 93% rename from template/module/readme/INSTALL.rst rename to template/module/readme/INSTALL.md index b62c6d1e9..77b98e7aa 100644 --- a/template/module/readme/INSTALL.rst +++ b/template/module/readme/INSTALL.md @@ -4,4 +4,4 @@ To install this module, you need to: -#. Do this ... +1. Do this ... diff --git a/template/module/readme/ROADMAP.rst b/template/module/readme/ROADMAP.md similarity index 96% rename from template/module/readme/ROADMAP.rst rename to template/module/readme/ROADMAP.md index 207233013..446840cfb 100644 --- a/template/module/readme/ROADMAP.rst +++ b/template/module/readme/ROADMAP.md @@ -2,4 +2,4 @@ It is mostly intended for end-users, and can also help potential new contributors discovering new features to implement. ] -* ... +- ... diff --git a/template/module/readme/USAGE.rst b/template/module/readme/USAGE.md similarity index 97% rename from template/module/readme/USAGE.rst rename to template/module/readme/USAGE.md index f4629c3d5..35260d672 100644 --- a/template/module/readme/USAGE.rst +++ b/template/module/readme/USAGE.md @@ -8,4 +8,4 @@ To use this module, you need to: -#. Go to ... +1. Go to ...