From a1d20f8e77f1f5ab4338a2176e82c87355d447dd Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sat, 11 Jan 2020 12:13:50 -0800 Subject: [PATCH] INSTALL: a few small tweaks and clarifications Signed-off-by: Elijah Newren --- INSTALL.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index fcf44df..98cc094 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -23,6 +23,8 @@ filter-repo only consists of a few files that need to be installed: If you want `git filter-repo --help` to display the manpage, this needs to be copied into $MANDIR/man1/ where $MANDIR is some entry from $MANPATH. + (Note that `git filter-repo -h` will show a more limited built-in set of + instructions regardless of whether the manpage is installed.) * git-filter-repo.html @@ -30,6 +32,7 @@ filter-repo only consists of a few files that need to be installed: version of the same page is provided for those who prefer it. Place it where ever you like; I have no idea where such a thing should go. + # Installation via Makefile Installing should be doable by hand, but a Makefile is provided for those @@ -42,19 +45,20 @@ Also, the Makefile will not edit the shebang line (the first line) of git-filter-repo if your python executable is not named "python3"; you'll still need to do that yourself. + # Installation via [pip](https://pip.pypa.io/) -Coming soon; see [PR #16](https://github.com/newren/git-filter-repo/pull/16). -Once it's in place, you'll be able to install via +For those who prefer to install python packages via pip, you merely need +to run: $ pip3 install git-filter-repo # Installation via Package Manager -There are [package -managers](https://alternativeto.net/software/yellowdog-updater-modified/?license=opensource) -for most operating systems; from +For those who prefer to install software via a [package +manager](https://alternativeto.net/software/yellowdog-updater-modified/?license=opensource) +for their operating system, there are many choices -- from [dnf](https://github.com/rpm-software-management/dnf) or [yum](http://yum.baseurl.org/) or [apt-get](https://www.debian.org/doc/manuals/debian-reference/ch02.en.html)