From c0966f3745e886825cc7a7301b50f466b169cf11 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=20D=C3=B6rr?= Date: Fri, 2 Apr 2021 20:46:36 +0200 Subject: [PATCH] Make installation command compatible with ZSH (#376) * Add quotes * Add Zsh bracket info * Add clarify pip installation line * Make note bold * Add Zsh pip installation note --- README.md | 1 + docs/guide/install.rst | 4 ++++ docs/misc/changelog.rst | 3 ++- 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ac13763..509633c 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,7 @@ Install the Stable Baselines3 package: ``` pip install stable-baselines3[extra] ``` +**Note:** Some shells such as Zsh require quotation marks around brackets, i.e. `pip install 'stable-baselines3[extra]'` ([More Info](https://stackoverflow.com/a/30539963)). This includes an optional dependencies like Tensorboard, OpenCV or `atari-py` to train on atari games. If you do not need those, you can use: ``` diff --git a/docs/guide/install.rst b/docs/guide/install.rst index 9632777..926836e 100644 --- a/docs/guide/install.rst +++ b/docs/guide/install.rst @@ -29,6 +29,10 @@ To install Stable Baselines3 with pip, execute: pip install stable-baselines3[extra] +.. note:: + Some shells such as Zsh require quotation marks around brackets, i.e. ``pip install 'stable-baselines3[extra]'`` `More information `_. + + This includes an optional dependencies like Tensorboard, OpenCV or ``atari-py`` to train on atari games. If you do not need those, you can use: .. code-block:: bash diff --git a/docs/misc/changelog.rst b/docs/misc/changelog.rst index 99effa6..6560975 100644 --- a/docs/misc/changelog.rst +++ b/docs/misc/changelog.rst @@ -31,6 +31,7 @@ Documentation: - Added link to SuperSuit in projects (@justinkterry) - Fixed DQN example (thanks @ltbd78) - Clarify channel-first/channel-last recommendation +- Clarify pip installation in Zsh (@tom-doerr) Release 1.0 (2021-03-15) @@ -640,4 +641,4 @@ And all the contributors: @tirafesi @blurLake @koulakis @joeljosephjin @shwang @rk37 @andyshih12 @RaphaelWag @xicocaio @diditforlulz273 @liorcohen5 @ManifoldFR @mloo3 @SwamyDev @wmmc88 @megan-klaiber @thisray @tfederico @hn2 @LucasAlegre @AptX395 @zampanteymedio @decodyng @ardabbour @lorenz-h @mschweizer @lorepieri8 -@ShangqunYu @PierreExeter @JacopoPan @ltbd78 +@ShangqunYu @PierreExeter @JacopoPan @ltbd78 @tom-doerr