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.

Sign up for GitHub

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

[Doc] Add how to set environment variables for fish users #1800

Merged
merged 3 commits into from
Aug 29, 2020
Merged

[Doc] Add how to set environment variables for fish users #1800

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a6292f2
[doc]: Add how to set environment variables for fish users
chengluyu Aug 28, 2020
c56e8af
[doc] shorten the description for fish users
chengluyu Aug 28, 2020
7012d87
[doc] enclose fish descriptions with note
chengluyu Aug 28, 2020
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
11 changes: 11 additions & 0 deletions docs/dev_install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,17 @@ Setting up Taichi for development

Then execute ``source ~/.bashrc`` to reload shell config.

If you're using fish. Use ``set -x`` to set environment variables. Execute following commands
or add them to ``~/.config/fish/config.fish`` (create if it doesn't exist).

.. code-block:: fish

set -x TAICHI_REPO_DIR /path/to/taichi
set -x PYTHONPATH $TAICHI_REPO_DIR/python $PYTHONPATH
set -x PATH $TAICHI_REPO_DIR/bin $PATH
# set -x CXX /path/to/clang # Uncomment if you encounter issue about compiler in the next step.
# set -x PATH /opt/llvm/bin $PATH # Uncomment if your llvm or clang is at somewhere else.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# set -x PATH /opt/llvm/bin $PATH # Uncomment if your llvm or clang is at somewhere else.
# set -x PATH /opt/llvm/bin:$PATH # Uncomment if your llvm or clang is at somewhere else.

Not super sure about fish, is this intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! This is intentional. See fish-shell/fish-shell#527 (comment) for an example.


* On Windows, please add these variables by accessing your system settings:

1. Add ``TAICHI_REPO_DIR`` whose value is the path to your taichi repository so that Taichi knows you're a developer.
Expand Down