From 75ad6498550c8fd8db8b2ae356124b67c23f7b95 Mon Sep 17 00:00:00 2001 From: Bodo Graumann Date: Tue, 22 Sep 2020 06:07:17 +0200 Subject: [PATCH] Inform user about option to skip changing PATH (#2945) I also added the `-` argument to `python`, because without it you cannot simply append flags for the script. Hope this is just the same for powershell, as for bash. Cf. #898 --- docs/docs/index.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/docs/index.md b/docs/docs/index.md index e22712bd0b8..64bb512f6cb 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -23,11 +23,11 @@ recommended way of installing `poetry`. ### osx / linux / bashonwindows install instructions ```bash -curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python +curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python - ``` ### windows powershell install instructions ```powershell -(Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python +(Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python - ``` !!! note @@ -38,9 +38,12 @@ curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poet The installer installs the `poetry` tool to Poetry's `bin` directory. On Unix it is located at `$HOME/.poetry/bin` and on Windows at `%USERPROFILE%\.poetry\bin`. -This directory will be in your `$PATH` environment variable, -which means you can run them from the shell without further configuration. -Open a new shell and type the following: +This directory will be automatically added to your `$PATH` environment variable, +by appending a statement to your `$HOME/.profile` configuration (or equivalent files). +If you do not feel comfortable with this, please pass the `--no-modify-path` flag to +the installer and manually add the Poetry's `bin` directory to your path. + +Finally, open a new shell and type the following: ```bash poetry --version