Sfoglia il codice sorgente

Update docs for pyenv and llvm (#570)

Jon Meow 4 anni fa
parent
commit
7af826e4df
1 ha cambiato i file con 15 aggiunte e 7 eliminazioni
  1. 15 7
      docs/project/contribution_tools.md

+ 15 - 7
docs/project/contribution_tools.md

@@ -104,13 +104,20 @@ Our recommended way of installing is:
 brew install pyenv
 pyenv install 3.8.5
 pyenv global 3.8.5
+```
+
+You will also need to update your rc file to add pyenv to your `PATH`; this
+should look like:
 
-# Add 'eval "$(pyenv init -)"' to your shell rc file, for example zshrc.
-echo 'eval "$(pyenv init -)"' >> ~/.zshrc
-# Load the shell rc file changes.
-exec $SHELL
+```bash
+export PYENV_ROOT="$HOME/.pyenv"
+export PATH="$PYENV_ROOT/bin:$PATH"
+eval "$(pyenv init --path)"
 ```
 
+Restart the shell (for example, `exec $SHELL`) to get `PATH` updates. If there
+are still issues, check instructions using `pyenv init`.
+
 To get the latest version of `pip` packages, it will be necessary to
 periodically run `pip list --outdated`, then `pip install -U <package>` to
 upgrade desired packages. Keep in mind when upgrading that version dependencies
@@ -200,9 +207,10 @@ Our recommended way of installing is:
 brew install llvm
 ```
 
-`llvm` is keg-only; bear in mind this requires updating `PATH` for it because
-it's not part of the standard Homebrew path. Read the output of `brew install`
-for the necessary path changes, or add something to your `PATH` like:
+On **MacOS only** (not Linux), `llvm` is keg-only; bear in mind this requires
+updating `PATH` for it because it's not part of the standard Homebrew path. Read
+the output of `brew install` for the necessary path changes, or add something to
+your `PATH` like:
 
 ```bash
 export PATH="$(brew --prefix llvm)/bin:${PATH}"