diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index eb6d9ba51..000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,25 +0,0 @@ -# Contributing - -## Developers installation - -Editable install with all requirements - -```python -pip install -r requirements.txt -e . -``` - -Start the main application - -```python -pymca -``` - -or using the module directly - -```python -python -m PyMca5.PyMcaGui.pymca.PyMcaMain -``` - -## Deployment - -TODO diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 000000000..51837eb87 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,28 @@ +Contributing +============ + +Developers installation +----------------------- + +Editable install with all requirements + +.. code:: bash + + pip install -r requirements.txt -e . + +Start the main application + +.. code:: bash + + pymca + +or using the module directly + +.. code:: bash + + python -m PyMca5.PyMcaGui.pymca.PyMcaMain + +Deployment +---------- + +TODO