Skip to content

Commit 05c7dfb

Browse files
committedNov 29, 2024·
INSTALL.md, README.md: make installation instructions less "sassy"
The complaints about the installation instructions will never end and I'll be fielding them until the end of time. No install process is too trivial for users to misunderstand and replace with ridiculously complex alternative undocumented and completely wrong instructions; unfortunately, venting about this reality causes other users to complain about my venting. It's a fair point, though, I shouldn't vent in the official documentation. That belongs somewhere that those users would never look, like commit messages. Touch up a few related items in the documentation while at it. Signed-off-by: Elijah Newren <[email protected]>
1 parent 40e3f56 commit 05c7dfb

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed
 

‎INSTALL.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,14 @@ If you place the git-filter-repo script in your $PATH, then you can
3131
shorten commands by replacing `python3 git-filter-repo` with `git
3232
filter-repo`; the manual assumes this but you can use the longer form.
3333

34-
If for some reason downloading a single file is too much of an
35-
installation hassle for you, or you really want some kind of "official
36-
installation", the other sections may have useful tips.
37-
3834
Optionally, if you also want to use some of the contrib scripts, then
3935
you need to make sure you have a `git_filter_repo.py` file which is
4036
either a link to or copy of `git-filter-repo`, and you need to place
4137
that git_filter_repo.py file in $PYTHONPATH.
4238

39+
If you prefer an "official" installation over the manual installation
40+
explained above, the other sections may have useful tips.
41+
4342
# Installation via Package Manager
4443

4544
If you want to install via some [package
@@ -147,7 +146,7 @@ you'll still need to do that yourself.
147146

148147
# Notes for Windows Users
149148

150-
Windows likes to make things difficult. Common and historical issues:
149+
Sadly, Windows sometimes makes things difficult. Common and historical issues:
151150

152151
* **Non-functional Python stub**: Windows apparently ships with a
153152
[non-functional
@@ -160,11 +159,11 @@ Windows likes to make things difficult. Common and historical issues:
160159
[Python](https://docs.microsoft.com/en-us/windows/python/beginners)
161160
from the [Microsoft
162161
Store](https://apps.microsoft.com/store/search?publisher=Python%20Software%20Foundation)
163-
* **Modifying PATH, making the script executable**: For some reason lots of
164-
Windows users have a hard time modifying their PATH and/or making scripts
165-
executable. You can skip that step by just using
166-
`python3 git-filter-repo` instead of `git filter-repo` in your commands.
167-
* **Different python executable name**: It seems some users don't have
162+
* **Modifying PATH, making the script executable**: If modifying your PATH
163+
and/or making scripts executable is difficult for you, you can skip that
164+
step by just using `python3 git-filter-repo` instead of `git filter-repo`
165+
in your commands.
166+
* **Different python executable name**: Some users don't have
168167
a `python3` executable but one named something else like `python`
169168
or `python3.8` or whatever. You may need to edit the first line
170169
of the git-filter-repo script to specify the appropriate path. Or

‎README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,10 @@ filter-repo requires:
4444

4545
# How do I install it?
4646

47-
`git-filter-repo` is a single-file python script, which was done to make
48-
installation for basic use on many systems trivial: just place that
49-
file into your $PATH.
47+
While the `git-filter-repo` repository has many files, the main logic
48+
is all contained in a single-file python script named
49+
`git-filter-repo`, which was done to make installation for basic use
50+
on many systems trivial: just place that one file into your $PATH.
5051

5152
See [INSTALL.md](INSTALL.md) for things beyond basic usage or special
5253
cases. The more involved instructions are only needed if one of the

0 commit comments

Comments
 (0)
Please sign in to comment.