Elijah Newren 5 years ago
parent e817c0147c
commit e18e114919

@ -61,6 +61,7 @@ git.git](https://git.kernel.org/pub/scm/git/git.git/tree/Documentation/Submittin
broadly in the code base multiple times; but it's just a bad broadly in the code base multiple times; but it's just a bad
idea to use an abstraction that doesn't fit the data. idea to use an abstraction that doesn't fit the data.
* I generally like [PEP * I generally like [PEP
8](https://www.python.org/dev/peps/pep-0008/), but have used 8](https://www.python.org/dev/peps/pep-0008/), but used
two-space indents for years anyway -- and expect contributions two-space indents for years before learning of it and have just
to do the same. continued that habit. For consistency, contributions should also
use two-space indents and otherwise generally follow PEP 8.

@ -1,3 +1,5 @@
# What/why/where to install things
filter-repo only consists of a few files that need to be installed: filter-repo only consists of a few files that need to be installed:
* git-filter-repo * git-filter-repo
@ -28,6 +30,8 @@ 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 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. 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 Installing should be doable by hand, but a Makefile is provided for those
that prefer it. However, usage of the Makefile really requires overridding that prefer it. However, usage of the Makefile really requires overridding
at least a couple of the directories with sane values, e.g. at least a couple of the directories with sane values, e.g.
@ -36,4 +40,30 @@ at least a couple of the directories with sane values, e.g.
Also, the Makefile will not edit the shebang line (the first line) of Also, the Makefile will not edit the shebang line (the first line) of
git-filter-repo if your python executable is not named "python3"; git-filter-repo if your python executable is not named "python3";
you'll still need to do that yourself. 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).
# Installation via Package Manager
There are [package
managers](https://alternativeto.net/software/yellowdog-updater-modified/?license=opensource)
for most operating systems; 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)
or whatever for Linux, to [brew](https://brew.sh/) for Mac OS X, to
[scoop](https://scoop.sh/) for Windows. Nearly any of these tools
will reduce the installation instructions down to
$ PACKAGE_TOOL install git-filter-repo
I have no interest in tracking all these pre-built packages (nor
whether those who packaged git-filter-repo have made modifications or
left parts of it out), but apparently https://repology.org is willing
to track who has packaged it. So, using repology's packaging status
link, the following package managers have packaged git-filter-repo:
[![Packaging status](https://repology.org/badge/vertical-allrepos/git-filter-repo.svg)](https://repology.org/project/git-filter-repo/versions)

@ -43,11 +43,11 @@ filter-repo requires:
git-filter-repo is a single-file python script, which was done to make git-filter-repo is a single-file python script, which was done to make
installation for basic use trivial: just copy it into your $PATH. installation for basic use trivial: just copy it into your $PATH.
See [INSTALL](INSTALL) for things beyond basic usage or special cases. See [INSTALL.md](INSTALL.md) for things beyond basic usage or special
The more involved instructions are needed if you cases. The more involved instructions are needed if you
* are working with a python3 executable named something other than "python3" * are working with a python3 executable named something other than "python3"
* want to install documentation * want to install documentation (beyond the builtin docs shown with -h)
* want to run some of the [contrib](contrib/filter-repo-demos/) examples * want to run some of the [contrib](contrib/filter-repo-demos/) examples
* want to create your own python filtering scripts using filter-repo as a * want to create your own python filtering scripts using filter-repo as a
module/library module/library

Loading…
Cancel
Save