Commit c2472e9
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
1 file changed
Lines changed: 5 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -79,13 +79,17 @@ cd GitPython | |||
| 79 | 79 | ./init-tests-after-clone.sh | |
| 80 | 80 | ``` | |
| 81 | 81 | ||
| 82 | + On Windows, `./init-tests-after-clone.sh` can be run in a Git Bash shell. | ||
| 83 | + | ||
| 82 | 84 | 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`): | |
| 83 | 85 | ||
| 84 | 86 | ```bash | |
| 85 | 87 | gh repo clone GitPython | |
| 86 | 88 | ``` | |
| 87 | 89 | ||
| 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): | ||
| 89 | 93 | ||
| 90 | 94 | ```bash | |
| 91 | 95 | pip install -e ".[test]" | |
0 commit comments