From 23a2d40f9130a1b52912237070e6026bbbb69063 Mon Sep 17 00:00:00 2001 From: Andre Anjos <andre.dos.anjos@gmail.com> Date: Tue, 12 Feb 2019 15:43:57 +0100 Subject: [PATCH] [doc] Update installation instructions --- doc/install.rst | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/doc/install.rst b/doc/install.rst index 0f293915..4903bd88 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -8,17 +8,30 @@ ============== You can install this package via conda_, simply pointing to our stable or beta -channels:: +channels: - $ conda create -n bdt -c https://www.idiap.ch/software/bob/conda bob.devtools - # or, for beta releases: - $ conda create -n bdt -c https://www.idiap.ch/software/bob/conda/label/beta bob.devtools +.. code-block:: sh -We provide packages for both 64-bit Linux and MacOS. Once installed, you can -use these tools within the created environment like this:: + $ conda create -n bdt -c https://www.idiap.ch/software/bob/conda bob.devtools + # or, for beta releases: + $ conda create -n bdt -c https://www.idiap.ch/software/bob/conda/label/beta -c https://www.idiap.ch/software/bob/conda bob.devtools - $ conda activate bdt - (bdt) $ bdt --help +If you use one of our supported Python versions on your base environment, you +may also install ``bdt`` on it: + +.. code-block:: sh + + $ conda install -n base -c https://www.idiap.ch/software/bob/conda bob.devtools + # or, for beta releases: + $ conda install -n base -c https://www.idiap.ch/software/bob/conda/label/beta -c https://www.idiap.ch/software/bob/conda bob.devtools + +We provide packages for both 64-bit Linux and MacOS, for Python 3.6+. Once +installed, you can use these tools within the created environment like this: + +.. code-block:: sh + + $ conda activate base #or bdt, depending where you installed it + (bdt) $ bdt --help -- GitLab