Commit Graph

14 Commits (main)

Author SHA1 Message Date
Elijah Newren 9da70bddfa INSTALL.md: more workarounds for the insanity of Windows
Apparently trying to use a direct download link for the git-filter-repo
script results in Windows trying to give the file an unwanted extension.
Warn users about that stupidity.

While at it, also:
  * note in the pre-reqs section that we have later hints for Windows
    users about installing Python
  * provide an additional link for installing Python on Windows that
    isn't generic instructions about using Python on Windows but helps
    users find the latest python to install from the Microsoft store

Reported-by: Radu Terec <raduterec@gmail.com>
Signed-off-by: Elijah Newren <newren@gmail.com>
2 years ago
Elijah Newren 49488f5393 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 <newren@gmail.com>
2 years ago
Elijah Newren 2878d8bc68 INSTALL.md: simplify instructions and suggest `python3 git-filter-repo`
Signed-off-by: Elijah Newren <newren@gmail.com>
2 years ago
Markus Heidelberg 9cfde803db INSTALL.md: correct a filename with mixed underscore and dash
Signed-off-by: Markus Heidelberg <markus.heidelberg@web.de>
2 years ago
erickeller ced9a0ba03 Update mandb after installing the man page
When manually installing the manpage, also update the mandb.

Signed-off-by: Eric Keller <keller.eric@gmail.com>
3 years ago
Elijah Newren fd64b0c7c0 INSTALL.md: more clarifications and links
Someone was surprised by my claim that someone else had reported
Microsoft provided a stub or stripped down python.  Link to where it was
reported in case others hit the same problem.

Vilius Šumskas reported that the need to edit the shebang line has been
corrected with the newest Git for Windows, so update the text to note
this.  It's possible other users may still have problems given the
variety of Windows versions and the number of reports I had about this,
so I want to still leave links there for at least a little while.

Be more explicit about how pip is lame and provides virtually no benefit
since it leaves you to fix your $PATH yourself, which was the only step
that was needed in installing the whole package anyway.

Signed-off-by: Elijah Newren <newren@gmail.com>
3 years ago
Elijah Newren 7b09784d7b INSTALL.md: reference dscho's excellent python on git-for-windows fixes
Dscho made fixes to msys2, cygwin, git-for-windows, and contributed
several improvements to git-filter-repo that were merged in
js/windows-fixes.  Reference some of the fixes so that those who had
issues with git-filter-repo in the past may be willing to retry, and
update the installation instructions with relevant pointers.

Signed-off-by: Elijah Newren <newren@gmail.com>
3 years ago
Elijah Newren 74ea810872 INSTALL.md: add notes about common installation issues
Signed-off-by: Elijah Newren <newren@gmail.com>
4 years ago
Elijah Newren 2f26e4bce5 INSTALL.md: wording clarification on what repology.org tracks
Homebrew and scoop are both package managers and package repositories.
Fedora 32 is not a package manager, but does map to a package
repository.  Clarify wording that the list from repology.org is a list
of package repositories, not package managers.

Signed-off-by: Elijah Newren <newren@gmail.com>
4 years ago
Elijah Newren eb9ea17629 INSTALL.md: fix missing trailing backquote
Signed-off-by: Elijah Newren <newren@gmail.com>
4 years ago
Elijah Newren 34f761734b INSTALL.md: simplify manual installation instructions
Make use of `git --man-path` and `git --html-path` to simplify the
manual installation instructions a bit.  Also, there appears to be a
site.getsitepackages() call in python to give similar information about
where git_filter_repo.py can be installed.

Signed-off-by: Elijah Newren <newren@gmail.com>
4 years ago
Elijah Newren 423b7d2c89 INSTALL: streamline a bit and guide folks to package managers
Now that several package managers are packaging filter-repo (Debian and
Ubuntu seem to be the primary holdouts, but maybe treating Linux as
"covered" will pressure them to package it too), guide people to use
package managers for easy installation and streamline the wording.
Still keep the old instructions around, just move them later.

Signed-off-by: Elijah Newren <newren@gmail.com>
4 years ago
Elijah Newren a1d20f8e77 INSTALL: a few small tweaks and clarifications
Signed-off-by: Elijah Newren <newren@gmail.com>
4 years ago
Elijah Newren e1d126a1ea Reference package managers in installation instructions
Signed-off-by: Elijah Newren <newren@gmail.com>
5 years ago