change to rst, to better include README

README.rst

@@ -1,32 +1,36 @@
-# [AiiDA](https://www.aiida.net/) based Weather and Climate Workflow Tool
-WcFlow a library for creating weather and climate workflows from a ~yaml~ format inspired by [cylc](https://cylc.github.io/).
+Weather and Climate Workflow Tool based on AiiDA
+================================================
 
-## Install
+.. marker-readme
+
+WcFlow a library for creating weather and climate workflows from a yaml format inspired by `cylc <https://cylc.github.io/>`_ using `AiiDA <https://www.aiida.net/>`_ as workflow engine.
+
+.. marker-installation
+
+Install
+-------
 
 To install it please use
-```
-pip install -e .
-```
 
+.. code-block:: bash
+
+    pip install -e .
 
-## Developer tools
+.. marker-developer-tools
+
+Developer tools
+---------------
 
 To manage the repo we use `hatch` please install it
-```
-pip install hatch
-hatch test # run tests
-hatch fmt # run formatting
-hatch run docs:build # build docs
-```
-
-
-## Config Format
-
-##  Parser
-##  Previewer
-##  ICON plugin
-##  AiiDA Shell
-##  AiiDA WorkGraph
-## Resources:
+
+.. code-block:: bash
+
+    pip install hatch
+    hatch test # run tests
+    hatch fmt # run formatting
+    hatch run docs:build # build docs
+
+Resources
+---------
 - https://aiida-workgraph.readthedocs.io/en/latest/
 - https://github.com/superstar54/aiida-workgraph

docs/src/getting_started.rst

@@ -1,2 +1,6 @@
 Getting started
 ===============
+
+.. include:: ../../README.rst
+   :start-after: marker-readme
+   :end-before: marker-developer-tools

docs/src/index.rst

@@ -1,3 +1,3 @@
 .. toctree::
 
-   workflow.md
+   getting_started.rst

pyproject.toml

@@ -12,7 +12,7 @@ authors = [
   {name = 'Julian Geiger', email = '[email protected]'},
   {name = 'Alexander Goscinski', email = '[email protected]'},
 ]
-readme = 'README.md'
+readme = 'README.rst'
 classifiers = [
   'Development Status :: 1 - Planning',
   'Intended Audience :: Science/Research',
@@ -25,7 +25,7 @@ classifiers = [
   'Topic :: Scientific/Engineering',
   'Topic :: Scientific/Engineering :: Atmospheric Science',
 ]
-keywords = ["wc", "workflow"," icon", "aiida", "workgraph"]
+keywords = ["wc", "workflow"," icon", "aiida", "aiida-workgraph"]
 requires-python = '>=3.9'
 dependencies = [
 ]