Skip to content

Commit 49488f5

Browse files
committed
INSTALL.md: be slightly more explicit in a few cases
A few changes: * mention pre-requisites * provide a direct link to the raw git-filter-repo file * note that `git_filter_repo.py` and `git-filter-repo` are filenames * mention for the windows folks that the python executable can be a full absolute path as well. Signed-off-by: Elijah Newren <[email protected]>
1 parent 2878d8b commit 49488f5

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

INSTALL.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,24 @@
11
# Table of Contents
22

3+
* [Pre-requisites](#pre-requisites)
34
* [Simple Installation](#simple-installation)
45
* [Installation via Package Manager](#installation-via-package-manager)
56
* [Detailed installation explanation for
67
packagers](#detailed-installation-explanation-for-packagers)
78
* [Installation via Makefile](#installation-via-makefile)
89
* [Notes for Windows Users](#notes-for-windows-users)
910

11+
# Pre-requisites
12+
13+
Instructions on this page assume you have already installed both
14+
[Git](https://git-scm.com) and [Python](https://www.python.org/).
15+
1016
# Simple Installation
1117

1218
All you need to do is download the [git-filter-repo script in this
13-
repository](git-filter-repo). **That's it**. You're done.
19+
repository](git-filter-repo) ([direct link to raw
20+
file](https://raw.githubusercontent.com/newren/git-filter-repo/main/git-filter-repo)).
21+
**That's it**. You're done.
1422

1523
Then you can run any command you want, such as
1624

@@ -25,8 +33,8 @@ installation hassle for you, or you really want some kind of "official
2533
installation", the other sections may have useful tips.
2634

2735
Optionally, if you also want to use some of the contrib scripts, then
28-
you need to make sure you have a git_filter_repo.py file which is
29-
either a link to or copy of git-filter-repo, and you need to place
36+
you need to make sure you have a `git_filter_repo.py` file which is
37+
either a link to or copy of `git-filter-repo`, and you need to place
3038
that git_filter_repo.py file in $PYTHONPATH.
3139

3240
# Installation via Package Manager
@@ -159,7 +167,7 @@ Windows likes to make things difficult. Common and historical issues:
159167
filter-repo commands. Namely, replace the `git filter-repo` part
160168
of commands with `PYTHON_EXECUTABLE git-filter-repo`. (Where
161169
`PYTHON_EXECUTABLE` is something like `python` or `python3.8` or
162-
whatever).
170+
`C:\PATH\TO\INSTALLATION\OF\python3.exe` or whatever).
163171
* **Symlink issues**: git_filter_repo.py is supposed to be a symlink to
164172
git-filter-repo, so that it appears to have identical contents.
165173
If your system messed up the symlink (usually meaning it looks like a

0 commit comments

Comments
 (0)