summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTim Oram <dev@mitmaro.ca>2024-06-12 09:18:05 -0230
committerTim Oram <dev@mitmaro.ca>2024-06-12 13:15:16 -0400
commitf2f893b68823ee5fe537cbe0f59e385da8c2fa0b (patch)
tree47e2ecc4d111796d40eb64e645c55c234a64dd37
parenta9e8c4012195c65225652a5b9077acd05f431f30 (diff)
Cleanup README for the 2.4.0 release
-rw-r--r--Makefile.toml6
-rw-r--r--README.md20
-rw-r--r--readme/install.md157
3 files changed, 87 insertions, 96 deletions
diff --git a/Makefile.toml b/Makefile.toml
index 5b7f591..388fdc2 100644
--- a/Makefile.toml
+++ b/Makefile.toml
@@ -42,6 +42,12 @@ command = "cargo"
dependencies = ["update-rust-stable", "build-release"]
args = ["deb"]
+[tasks.build-rpm]
+toolchain = "stable"
+command = "cargo"
+dependencies = ["update-rust-stable", "build-release"]
+args = ["generate-rpm"]
+
[tasks.clean]
dependencies = ["update-rust-stable"]
toolchain = "stable"
diff --git a/README.md b/README.md
index fb9ffbf..9855c7c 100644
--- a/README.md
+++ b/README.md
@@ -9,8 +9,6 @@ Native cross-platform full feature terminal based [sequence editor][git-sequence
[![Git Interactive Rebase Tool](/docs/assets/images/girt-demo.gif?raw=true)](https://youtu.be/q3tzb-gQC0w)
-**This is the documentation for the development build. For the current stable release, please use the [2.3.x documentation](https://github.com/MitMaro/git-interactive-rebase-tool/tree/2.3.0/README.md).**
-
## Table of Contents
* [Features](./README.md#features)
@@ -145,7 +143,6 @@ GitBash requires the use of `winpty` in order to work correctly, so to set the e
Windows before version 10 has [serious rendering issues with saturated darker colors](https://devblogs.microsoft.com/commandline/updating-the-windows-console-colors/), such as the blue color that is entirely illegible on modern displays. While it is possible to avoid using saturated colors, a better option is to update the theme using Microsoft's [ColorTool](https://github.com/Microsoft/Terminal/tree/master/src/tools/ColorTool).
-
### Temporary Override
You can temporarily use a different sequence editor by using the `GIT_SEQUENCE_EDITOR` environment variable:
@@ -224,9 +221,9 @@ The tool is tested in [iTerm2](https://www.iterm2.com/) and [Terminal](https://s
### Windows
-Supported on the latest versions of Windows 8.1 and Windows 10 and Windows 11.
+Supported on the latest versions of Windows 10 and Windows 11.
-The tool is tested on Windows 10 in [PowerShell](https://docs.microsoft.com/powershell/) and Command Prompt inside [Windows Console](https://docs.microsoft.com/windows/console/) and [Windows Terminal](https://docs.microsoft.com/windows/terminal/). The latest version of Git Bash provided from [Git for Windows](https://gitforwindows.org/) is also supported.
+The tool is tested on Windows 11 in [PowerShell](https://docs.microsoft.com/powershell/) and Command Prompt inside [Windows Console](https://docs.microsoft.com/windows/console/) and [Windows Terminal](https://docs.microsoft.com/windows/terminal/). The latest version of Git Bash provided from [Git for Windows](https://gitforwindows.org/) is also supported.
Windows Console and Git Bash are only minimally supported, and some features or graphical glitches may occur. Windows Console running in [legacy mode](https://docs.microsoft.com/windows/console/legacymode) is not supported.
@@ -303,11 +300,17 @@ An addition to the report printed to the CLI, an HTML report can be found in the
### Release
-#### Debian Building
+#### Debian Packaging Building
+
+ cargo make build-deb
+
+A deb file will be written to `target/debian/git-interactive-rebase-tool_*.deb`.
+
+#### RPM Building
- cargo make deb
+ cargo make build-rpm
-A deb file will be written to `target/debian/interactive-rebase-tool_*.deb`.
+A rpm file will be written to `target/generate-rpm/git-interactive-rebase-tool-*.deb`.
#### Reproducible Builds
@@ -317,6 +320,7 @@ Providing a [`SOURCE_DATE_EPOCH`](https://reproducible-builds.org/specs/source-d
* [rebase-editor](https://github.com/sjurba/rebase-editor) is a very similar project written in Node.js.
* [cj-git-patchtool](https://github.com/pflanze/cj-git-patchtool) is another tool for doing git rebase en masse.
+* [andrewshadura/git-crecord](https://github.com/andrewshadura/git-crecord) provides interactive selection of changes to a commit.
## License
diff --git a/readme/install.md b/readme/install.md
index 370e28b..820e7b2 100644
--- a/readme/install.md
+++ b/readme/install.md
@@ -2,144 +2,125 @@
## Table of Contents
-* [Alpine Linux](./install.md#alpine-linux)
-* [Arch Linux](./install.md#arch-linux)
-* [Cargo Package Manager](./install.md#cargo-package-manager)
-* [Debian and derivatives](./install.md#debian-and-derivatives)
-* [GNU Guix](./install.md#gnu-guix-package-manager)
-* [FreeBSD](./install.md#freebsd)
-* [macOS](./install.md#macos)
-* [Windows](./install.md#windows)
+* [Official Installation Methods](#official-installation-methods)
+ * [Debian and derivatives](#debian-and-derivatives)
+ * [Red Hat Linux, Fedora and derivatives](#red-hat-linux-fedora-and-derivatives)
+ * [macOS](#macos)
+ * [Windows](#windows)
+ * [Alpine, Arch, and Raspberry Pi OS](#alpine-arch-and-raspberry-pi-os)
+* [Cargo Package Manager](#cargo-package-manager-most-platforms)
+* [Community Supported Repositories](#community-supported-repositories)
+ * [Alpine Linux](#alpine-linux)
+ * [Arch Linux](#arch-linux)
+ * [Gnu Guix Package Manager](#gnu-guix-package-manager)
+ * [FreeBSD](#freebsd)
+ * [Windows](#windows-1)
+
+## Official Installation Methods
+
+### Debian and derivatives
-## Alpine Linux
-
-Install the [git-interactive-rebase-tool](https://pkgs.alpinelinux.org/packages?name=git-interactive-rebase-tool) package from the community repository (since Alpine v3.14):
+Download the `.deb` file from the [releases page][releases] and install with:
- apk add git-interactive-rebase-tool
+ sudo dpkg -i /path/to/git-interactive-rebase-tool-*.deb
-## Arch Linux
+The executable will be installed to `/usr/bin`.
-### With your [AUR](https://aur.archlinux.org/) helper of choice
+### Red Hat Linux, Fedora and derivatives
- yay -S git-interactive-rebase-tool
+Download the `.rpm` file from the [releases page][releases] and install with your package manager of choice:
-### Manual Install
+ sudo rpm -i /path/to/git-interactive-rebase-tool-*.rpm
+ sudo yum localinstall /path/to/git-interactive-rebase-tool-*.rpm
+ sudo dnf localinstall /path/to/git-interactive-rebase-tool-*.rpm
-1. Download the [package snapshot](https://aur.archlinux.org/packages/git-interactive-rebase-tool/)
-1. Extract to a known location
-1. Run `makepkg -si` from the extracted location
+### macOS
-#### Troubleshooting
+#### With [Homebrew](https://brew.sh/)
-If you receive the error, "no default toolchain configured", run `rustup default stable` and then retry the installation.
-This generally happens when `rustup` is installed without setting a default toolchain.
+ brew install git-interactive-rebase-tool
-### Remove
+#### Manual install
- sudo pacman -R git-interactive-rebase-tool
+Download the macOS binary from the [releases page][releases] and copy it as `interactive-rebase-tool` to a location on your `PATH`.
-## Cargo Package Manager
+#### Notes
- cargo install git-interactive-rebase-tool
-
-### Remove
+On macOS, Terminal.app does not support highlighting the selected line(s). If you want this feature you will need to use
+a terminal emulator like [iTerm2](https://iterm2.com/index.html).
- cargo uninstall git-interactive-rebase-tool
+### Windows
-## Debian and derivatives
+*Note: Windows binaries are not fully tested. If you are having issues please report them.*
-Download the `.deb` file from the [releases page][releases] and install with:
+Download the tool from the [releases page][releases] and save it to a known location.
- sudo dpkg -i /path/to/git-interactive-rebase-tool_*.deb
+### Alpine, Arch, and Raspberry Pi OS
-The executable will be installed to `/usr/bin`.
+#### Manual Install
-### Remove
+Download the binary from the [releases page][releases] and copy it as `interactive-rebase-tool` to a location on your `PATH`.
- sudo dpkg -r git-interactive-rebase-tool
-
-## Gnu Guix Package Manager
+## Cargo Package Manager (Most platforms)
- guix install git-interactive-rebase-tool
+The project can be installed directly from [crates.io](https://crates.io/crates/git-interactive-rebase-tool) via cargo.
-### Remove
+ cargo install git-interactive-rebase-tool
- guix remove git-interactive-rebase-tool
-
-### In a temporary environment
+## Community Supported Repositories
- guix shell git-interactive-rebase-tool
-
-### In a temporary container (Linux namespace)
+Community supported repositories are not officially supported, as they are maintained by community members. As such, they do not always provide the latest version. If you run into an issue with a community repository, please reach out to the community member supporting the platform.
- guix shell --container git-interactive-rebase-tool
+### Alpine Linux
-## FreeBSD
+Install the [git-interactive-rebase-tool](https://pkgs.alpinelinux.org/packages?name=git-interactive-rebase-tool) package from the community repository (since Alpine v3.14):
-### With [Ports](https://www.freebsd.org/ports/)
+ apk add git-interactive-rebase-tool
-#### Using pkg
+### Arch Linux
- pkg install interactive_rebase_tool
+With your [AUR](https://aur.archlinux.org/) helper of choice:
-#### Manual
+ yay -S git-interactive-rebase-tool
- cd /usr/ports/devel/interactive_rebase_tool && make install clean
+#### Manual Install
-#### Remove
+1. Download the [package snapshot](https://aur.archlinux.org/packages/git-interactive-rebase-tool/)
+2. Extract to a known location
+3. Run `makepkg -si` from the extracted location
- pkg remove interactive_rebase_tool
+### Gnu Guix Package Manager
-## macOS
+ guix install git-interactive-rebase-tool
-### With [Homebrew](https://brew.sh/)
+#### In a temporary environment
- brew install git-interactive-rebase-tool
+ guix shell git-interactive-rebase-tool
-#### Remove
+#### In a temporary container (Linux namespace)
- brew rm git-interactive-rebase-tool
+ guix shell --container git-interactive-rebase-tool
-### Manual install
+### FreeBSD
-Download the `macos-interactive-rebase-tool` from the [releases page][releases] and copy it as `interactive-rebase-tool`
-to a location on your `PATH`.
+FreeBSD support is provided by the community, and while attempts are made to ensure everything works on the platform, it is not officially supported. If you run into problems please [create an issue](https://github.com/MitMaro/git-interactive-rebase-tool/issues/new) describing the problem.
-#### Remove
+With [Ports](https://www.freebsd.org/ports/) using `pkg`
-Delete the copied `interactive-rebase-tool`.
+ pkg install interactive_rebase_tool
-### Notes
+#### Manual
-On macOS, Terminal.app does not support highlighting the selected line(s). If you want this feature you will need to use
-a terminal emulator like [iTerm2](https://iterm2.com/index.html).
+ cd /usr/ports/devel/interactive_rebase_tool && make install clean
-## Windows
+### Windows
-### With [Chocolatey](https://chocolatey.org/)
+#### With [Chocolatey](https://chocolatey.org/)
choco install git-interactive-rebase-tool
-#### Remove
-
- choco uninstall git-interactive-rebase-tool
-
-### With [Scoop](https://scoop.sh/)
+#### With [Scoop](https://scoop.sh/)
scoop install git-interactive-rebase-tool
-#### Remove
-
- scoop uninstall git-interactive-rebase-tool
-
-### Manual Install
-
-*Note: Windows binaries are not fully tested. If you are having issues please report them.*
-
-Download the tool from the [releases page][releases] and save it to a known location.
-
-#### Remove
-
-Delete the saved executable.
-
[releases]:https://github.com/MitMaro/git-interactive-rebase-tool/releases