docs: update instructions for how to install from source (#629)

syne-tune · Apr 17, 2023 · 4eac1f4 · 4eac1f4
1 parent 7e59a01
commit 4eac1f4
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -28,13 +28,14 @@ To install Syne Tune from pip, you can simply do:
 pip install 'syne-tune[extra]'
 ```
 
-or to get the latest version from git: 
+or to install the latest version from source (necessary to run the scripts in the [examples/](https://github.com/awslabs/syne-tune/tree/main/examples) folder): 
 
 ```bash
 git clone https://github.com/awslabs/syne-tune.git
 cd syne-tune
 python3 -m venv st_venv
 . st_venv/bin/activate
+pip install wheel
 pip install --upgrade pip
 pip install -e '.[extra]'
 ```

diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -17,6 +17,7 @@ install Syne Tune from source:
    cd syne-tune
    python3 -m venv st_venv
    . st_venv/bin/activate
+   pip install wheel
    pip install --upgrade pip
    pip install -e '.[extra]'