Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated readme to address potential issue with MacOs #341

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,14 @@ wget -qO - https://nim-lang.org/choosenim/init.sh | sh
script to install by specifying the ``CHOOSENIM_CHOOSE_VERSION``
environment variable.

**PATH setup** If `choosenim` has been installed successfully, and you're still not able to use Nim or any of the tooling (ex: `nim --v`) follow these steps in your terminal:
- MacOs: modify or create the `~/.zshenv` file with your preferred editor, e.g. `nano ~/.zshenv`
- Linux: modify or create file `~/.bash_profile`, e.g. `nano ~/.bash_profile`
- add the following line to setup the PATH correctly: `export PATH="$HOME/.nimble/bin:$PATH"`
- make sure the current terminal session picks up the changes with this line: `source ~/.zshenv` or `source ~/.bash_profile`
- now validate everything works properly with: `nim --v`

By creating a `.zshenv` or `.bash_profile` file and adding the path to `~/.nimble/bin`, you're ensuring that your shell (terminal) knows where to look for your Nim executables and other tooling every time it starts up.
## How choosenim works

Similar to the likes of ``rustup`` and ``pyenv``, ``choosenim`` is a
Expand Down