diff --git a/README.md b/README.md index da4dfb6..9216e72 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,20 @@ commit-patch Commit patches to Darcs, Git, Mercurial, Bazaar, Monotone, Subversion, or CVS +Installation +------------ + +On a recent Debian/Ubuntu: + + apt install commit-patch + +Anywhere else: Install the prerequisites below and download the release +tarball from the [homepage](https://porkrind.org/commit-patch/). This +tarball contains a "fatpackad" version of the `commit-patch` perl script +with the external perl dependencies embedded. Then put the commit-patch +and commit-partial binaries into your `PATH`. + + Prerequisites ------------- @@ -32,16 +46,15 @@ and, of course, one of: On Debian/Ubuntu: - apt-get install libipc-run-perl patch patchutils + apt-get install patch patchutils On Fedora: - yum install perl-IPC-Run patch patchutils + yum install patch patchutils On Mac OS X w/ [Homebrew](https://brew.sh) brew install patchutils - cpan -i IPC::Run Instructions @@ -74,6 +87,17 @@ the resulting hunks using diff mode's built-in commands and to then hit `C-c C-c` to commit the patch. +Development +----------- + +`commit-patch` uses [Carton](https://github.com/perl-carton/carton) for +local development. Once Carton is installed: + + carton install + +After than `commit-patch` and `commit-partial` should work (there is no +need to `carton exec` them—the code autodetects the local libs. + Homepage --------