diff options
| author | Zopolis4 <creatorsmithmdt@gmail.com> | 2021-10-27 16:31:26 +1100 |
|---|---|---|
| committer | Zopolis4 <creatorsmithmdt@gmail.com> | 2021-10-27 16:44:40 +1100 |
| commit | 38644b5966c9cb54384accd01ee985ef07ef5d3f (patch) | |
| tree | 408415c0bfea26662fca98be45ec04cd5e36f13d /README.md | |
| parent | 8ab8033f6992f0ccf8a30114cf2732c89a33425e (diff) | |
Update readme to reflect CI builds
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 13 insertions, 11 deletions
@@ -1,7 +1,5 @@ # git absorb -[](https://crates.io/crates/git-absorb) - This is a port of Facebook's [`hg absorb`](https://bitbucket.org/facebook/hg-experimental/src/default/hgext3rd/absorb/__init__.py?at=default&fileviewer=file-view-default), which I first read about on [mozilla.dev.version-control](https://groups.google.com/forum/#!msg/mozilla.dev.version-control/nh4fITFlEMk/ZNXgnAzxAQAJ). ## Elevator Pitch @@ -26,13 +24,7 @@ git rebase -i --autosquash master ## Installing -You will need the following: - -- [cargo](https://github.com/rust-lang/cargo) - -Then `cargo install git-absorb`. Make sure that `$CARGO_HOME/bin` is on your `$PATH` so that git can find the command. (`$CARGO_HOME` defaults to `~/.cargo`.) - -Note that `git absorb` does _not_ use the system libgit2. This means you do not need to have libgit2 installed to build or run it. However, this does mean you have to be able to build libgit2. (Due to [recent changes](https://github.com/alexcrichton/git2-rs/commit/76f4b74aef2bc2a54906ddcbf7fbe0018936a69d) in the git2 crate, CMake is no longer needed to build it.) +The easiest way to install `git absorb` is to download the latest CI artifact from the actions tab. Artifacts are available for Windows, MacOS and Ubuntu. Alternatively, `git absorb` is available in the following system package managers: @@ -45,6 +37,18 @@ Alternatively, `git absorb` is available in the following system package manager | nixpkgs stable and unstable | `nix-env -iA nixpkgs.gitAndTools.git-absorb` | | Void Linux | `xbps-install -S git-absorb` | +## Compiling from Source + +[](https://crates.io/crates/git-absorb) + +You will need the following: + +- [cargo](https://github.com/rust-lang/cargo) + +Then `cargo install git-absorb`. Make sure that `$CARGO_HOME/bin` is on your `$PATH` so that git can find the command. (`$CARGO_HOME` defaults to `~/.cargo`.) + +Note that `git absorb` does _not_ use the system libgit2. This means you do not need to have libgit2 installed to build or run it. However, this does mean you have to be able to build libgit2. (Due to [recent changes](https://github.com/alexcrichton/git2-rs/commit/76f4b74aef2bc2a54906ddcbf7fbe0018936a69d) in the git2 crate, CMake is no longer needed to build it.) + Note: `cargo install` does not currently know how to install manpages ([cargo#2729](https://github.com/rust-lang/cargo/issues/2729)), so if you use `cargo` for installation then `git absorb --help` will not work. Here is a manual workaround, assuming your system has a `~/.local/share/man/man1` directory that `man --path` knows about: ``` @@ -92,8 +96,6 @@ edit your local or global `.gitconfig` and add the following section - stop using `failure::err_msg` and ensure all error output is actionable by the user - slightly more log output in the success case - more tests (esp main module and integration tests) -- travis -- windows support and appveyor - document stack and commute details - more commutation cases (esp copy/rename detection) - don't load all hunks in memory simultaneously because they could be huge |