diff --git a/README.rst b/README.md similarity index 100% rename from README.rst rename to README.md diff --git a/doc/source/info.rst b/doc/source/info.rst index 38ba804..c8d6969 100644 --- a/doc/source/info.rst +++ b/doc/source/info.rst @@ -1 +1 @@ -.. include:: ../../README.rst \ No newline at end of file +.. include:: ../../README.md \ No newline at end of file diff --git a/src/README.rst b/src/README.rst index 5313a00..0b51451 100644 --- a/src/README.rst +++ b/src/README.rst @@ -1,4 +1,25 @@ -## instalation +************ +Installation +************ +Requirements +============ -bye bye \ No newline at end of file +- Python +- pip + +Installing by using PyPi +======================== + +Install +------- +.. code-block:: bash + + git clone ttps://github.com/intsystems/discrete-variables-relaxation.git /tmp/discrete-variables-relaxation + python3 -m pip install /tmp/discrete-variables-relaxation/src/ + +Uninstall +--------- +.. code-block:: bash + + python3 -m pip uninstall relaxit \ No newline at end of file