Merge pull request #578 from OCA/convert-to-md

Convert readme fragment examples to markdown
OCA · Sep 14, 2023 · 1070863 · 1070863
2 parents 969238e + 641bdf6
commit 1070863
Show file tree

Hide file tree

Showing 10 changed files with 18 additions and 22 deletions.
diff --git a/template/module/readme/CONFIGURE.rst → template/module/readme/CONFIGURE.md b/template/module/readme/CONFIGURE.rst → 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 → template/module/readme/CONTEXT.md b/template/module/readme/CONTEXT.rst → template/module/readme/CONTEXT.md
diff --git a/template/module/readme/CONTRIBUTORS.md b/template/module/readme/CONTRIBUTORS.md
@@ -0,0 +1,2 @@
+- Firstname Lastname <[email protected]> (optional company website url)
+- Second Person <[email protected]> (optional company website url)
diff --git a/template/module/readme/CONTRIBUTORS.rst b/template/module/readme/CONTRIBUTORS.rst
diff --git a/template/module/readme/CREDITS.rst → template/module/readme/CREDITS.md b/template/module/readme/CREDITS.rst → 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 → template/module/readme/DESCRIPTION.md b/template/module/readme/DESCRIPTION.rst → template/module/readme/DESCRIPTION.md
diff --git a/template/module/readme/HISTORY.rst → template/module/readme/HISTORY.md b/template/module/readme/HISTORY.rst → 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 <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>`_)
+- [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 → template/module/readme/INSTALL.md b/template/module/readme/INSTALL.rst → 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 → template/module/readme/ROADMAP.md b/template/module/readme/ROADMAP.rst → 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 → template/module/readme/USAGE.md b/template/module/readme/USAGE.rst → template/module/readme/USAGE.md
@@ -8,4 +8,4 @@
 
 To use this module, you need to:
 
-#. Go to ...
+1. Go to ...