Skip to content
This repository was archived by the owner on Feb 10, 2026. It is now read-only.

Commit 5a8cc03

Browse files
committed
Added installation section to README
1 parent c6a06ff commit 5a8cc03

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,49 @@
11
# zsh-auto-venv
22
Automatically activate venv when enter the project folder
3+
4+
## Installation
5+
6+
### [antigen](https://github.com/zsh-users/antigen)
7+
8+
1. Add the following to your `.zshrc`:
9+
10+
```sh
11+
antigen bundle ikhomutov/zsh-auto-venv
12+
```
13+
14+
2. Start a new terminal session.
15+
16+
### [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh)
17+
18+
1. Clone this repository into `$ZSH_CUSTOM/plugins` (by default `~/.oh-my-zsh/custom/plugins`)
19+
20+
```sh
21+
git clone https://github.com/ikhomutov/zsh-auto-venv ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-auto-venv
22+
```
23+
24+
2. Add the plugin to the list of plugins for Oh My Zsh to load (inside `~/.zshrc`):
25+
26+
```sh
27+
plugins=(
28+
...
29+
zsh-auto-venv
30+
)
31+
```
32+
33+
3. Start a new terminal session.
34+
35+
### Manual (Git Clone)
36+
37+
1. Clone this repository somewhere on your machine. This guide will assume `~/.zsh/zsh-autosuggestions`.
38+
39+
```sh
40+
git clone https://github.com/ikhomutov/zsh-auto-venv ~/.zsh/zsh-auto-venv
41+
```
42+
43+
2. Add the following to your `.zshrc`:
44+
45+
```sh
46+
source ~/.zsh/zsh-auto-venv/zsh-auto-venv.zsh
47+
```
48+
49+
3. Start a new terminal session.

0 commit comments

Comments
 (0)