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

Explain the logic in README.md #5

Open
wants to merge 1 commit into
base: main
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
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,7 @@ fisher install nakulj/auto-venv
### Manual install

Copy `conf.d/venv.fish` into your `conf.d` directory (usually `~/.config/fish/conf.d`)

## Working logic

The function is called after each directory change. It searches for a directory called `env` `.env` `venv` or `.venv` in the current working directory, or root directory of the git repo if the current directory is in a git repo. If the virtual environment is not yet activated, the fish-specific activation command for this virtual environment is sourced.