Use reST for README

sphinx-doc · May 27, 2021 · fb7a645 · fb7a645
1 parent 1e77928
commit fb7a645
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/doc/tutorial/index.rst b/doc/tutorial/index.rst
@@ -35,12 +35,13 @@ Setting up our project and development environment
 ..................................................
 
 On a new directory,
-create a file called ``README.md``
+create a file called ``README.rst``
 with the following contents:
 
-.. code-block:: markdown
+.. code-block:: rest
 
-   # Lumache
+   Lumache
+   =======
 
    **Lumache** (/luˈmake/) is a Python library for cooks and food lovers
    that creates recipes mixing random ingredients.