Skip to content

Commit c2472e9

Browse files
committed
Note that the init script can be run from Git Bash
This is probably the *only* way anyone should run that script on Windows, but I don't know of specific bad things that happen if it is run in some other way, such as with WSL bash, aside from messing up line endings, which users are likely to notice anyway. This commit also clarifies the instructions by breaking up another paragraph that really represented two separate steps.
1 parent 9e245d0 commit c2472e9

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

Diff for: README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -79,13 +79,17 @@ cd GitPython
7979
./init-tests-after-clone.sh
8080
```
8181

82+
On Windows, `./init-tests-after-clone.sh` can be run in a Git Bash shell.
83+
8284
If you are cloning [your own fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks), then replace the above `git clone` command with one that gives the URL of your fork. Or use this [`gh`](https://cli.github.com/) command (assuming you have `gh` and your fork is called `GitPython`):
8385

8486
```bash
8587
gh repo clone GitPython
8688
```
8789

88-
Having cloned the repo, create and activate your [virtual environment](https://docs.python.org/3/tutorial/venv.html). Then make an [editable install](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs):
90+
Having cloned the repo, create and activate your [virtual environment](https://docs.python.org/3/tutorial/venv.html).
91+
92+
Then make an [editable install](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs):
8993

9094
```bash
9195
pip install -e ".[test]"

0 commit comments

Comments
 (0)