diff --git a/README.md b/README.md index e1303d8ce..6440cc2cd 100644 --- a/README.md +++ b/README.md @@ -15,14 +15,13 @@ This repository aims to implement methods from PN in Python 3 and to provide a c currently a work in progress, therefore interfaces are subject to change. ## Installation -You can install this Python 3 package using `pip` (or `pip3`): +To get started install ProbNum using :code:`pip`. ```bash -pip install git+https://github.com/probabilistic-numerics/probnum.git +pip install probnum ``` -Alternatively you can clone this repository with +Alternatively, you can install the package from source. ```bash -git clone https://github.com/probabilistic-numerics/probnum -pip install probnum/. +pip install git+https://github.com/probabilistic-numerics/probnum.git ``` ## Documentation and Examples diff --git a/docs/source/index.rst b/docs/source/index.rst index 3b9a8c72c..772e2ea64 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -13,14 +13,14 @@ measures over the output of a numerical routine, which then can be propagated al This repository aims to implement methods from PN in Python 3 and to provide a common interface for them. This is currently a work in progress, therefore interfaces are subject to change. -To get started install ProbNum from the Python Package Index via +To get started install ProbNum using :code:`pip`. .. code-block:: shell pip install probnum -or if you prefer to use the latest version, install directly from Github: +Alternatively, you can install the package from source. .. code-block:: shell diff --git a/docs/source/introduction/quickstart.ipynb b/docs/source/introduction/quickstart.ipynb index b6456451d..06fd87e6a 100644 --- a/docs/source/introduction/quickstart.ipynb +++ b/docs/source/introduction/quickstart.ipynb @@ -41,7 +41,7 @@ "```bash\n", "pip install probnum\n", "```\n", - "If you prefer to use the latest version of ProbNum, install directly from GitHub instead.\n", + "Alternatively, you can install the package from source.\n", "\n", "```bash\n", "pip install git+https://github.com/probabilistic-numerics/probnum.git\n", diff --git a/setup.cfg b/setup.cfg index 086ad3331..5227644fd 100644 --- a/setup.cfg +++ b/setup.cfg @@ -11,7 +11,7 @@ author = Jonathan Wenger author-email = jonathan.wenger@uni-tuebingen.de license = mit long-description = file: README.md -long-description-content-type = text/x-rst; charset=UTF-8 +long-description-content-type = text/markdown # Change if running only on Windows, Mac or Linux (comma-separated) platforms = any # Add here all kinds of additional classifiers as defined under