Skip to content

Commit f2f893b

Browse files
MitMaroMitMaro
committed
Cleanup README for the 2.4.0 release
1 parent a9e8c40 commit f2f893b

File tree

3 files changed

+87
-96
lines changed

3 files changed

+87
-96
lines changed

‎Makefile.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ command = "cargo"
4242
dependencies = ["update-rust-stable", "build-release"]
4343
args = ["deb"]
4444

45+
[tasks.build-rpm]
46+
toolchain = "stable"
47+
command = "cargo"
48+
dependencies = ["update-rust-stable", "build-release"]
49+
args = ["generate-rpm"]
50+
4551
[tasks.clean]
4652
dependencies = ["update-rust-stable"]
4753
toolchain = "stable"

‎README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ Native cross-platform full feature terminal based [sequence editor][git-sequence
99

1010
[![Git Interactive Rebase Tool](/docs/assets/images/girt-demo.gif?raw=true)](https://youtu.be/q3tzb-gQC0w)
1111

12-
**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).**
13-
1412
## Table of Contents
1513

1614
* [Features](./README.md#features)
@@ -145,7 +143,6 @@ GitBash requires the use of `winpty` in order to work correctly, so to set the e
145143

146144
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).
147145

148-
149146
### Temporary Override
150147

151148
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
224221

225222
### Windows
226223

227-
Supported on the latest versions of Windows 8.1 and Windows 10 and Windows 11.
224+
Supported on the latest versions of Windows 10 and Windows 11.
228225

229-
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.
226+
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.
230227

231228
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.
232229

@@ -303,11 +300,17 @@ An addition to the report printed to the CLI, an HTML report can be found in the
303300

304301
### Release
305302

306-
#### Debian Building
303+
#### Debian Packaging Building
304+
305+
cargo make build-deb
306+
307+
A deb file will be written to `target/debian/git-interactive-rebase-tool_*.deb`.
308+
309+
#### RPM Building
307310

308-
cargo make deb
311+
cargo make build-rpm
309312

310-
A deb file will be written to `target/debian/interactive-rebase-tool_*.deb`.
313+
A rpm file will be written to `target/generate-rpm/git-interactive-rebase-tool-*.deb`.
311314

312315
#### Reproducible Builds
313316

@@ -317,6 +320,7 @@ Providing a [`SOURCE_DATE_EPOCH`](https://reproducible-builds.org/specs/source-d
317320

318321
* [rebase-editor](https://github.com/sjurba/rebase-editor) is a very similar project written in Node.js.
319322
* [cj-git-patchtool](https://github.com/pflanze/cj-git-patchtool) is another tool for doing git rebase en masse.
323+
* [andrewshadura/git-crecord](https://github.com/andrewshadura/git-crecord) provides interactive selection of changes to a commit.
320324

321325
## License
322326

‎readme/install.md

Lines changed: 69 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -2,144 +2,125 @@
22

33
## Table of Contents
44

5-
* [Alpine Linux](./install.md#alpine-linux)
6-
* [Arch Linux](./install.md#arch-linux)
7-
* [Cargo Package Manager](./install.md#cargo-package-manager)
8-
* [Debian and derivatives](./install.md#debian-and-derivatives)
9-
* [GNU Guix](./install.md#gnu-guix-package-manager)
10-
* [FreeBSD](./install.md#freebsd)
11-
* [macOS](./install.md#macos)
12-
* [Windows](./install.md#windows)
5+
* [Official Installation Methods](#official-installation-methods)
6+
* [Debian and derivatives](#debian-and-derivatives)
7+
* [Red Hat Linux, Fedora and derivatives](#red-hat-linux-fedora-and-derivatives)
8+
* [macOS](#macos)
9+
* [Windows](#windows)
10+
* [Alpine, Arch, and Raspberry Pi OS](#alpine-arch-and-raspberry-pi-os)
11+
* [Cargo Package Manager](#cargo-package-manager-most-platforms)
12+
* [Community Supported Repositories](#community-supported-repositories)
13+
* [Alpine Linux](#alpine-linux)
14+
* [Arch Linux](#arch-linux)
15+
* [Gnu Guix Package Manager](#gnu-guix-package-manager)
16+
* [FreeBSD](#freebsd)
17+
* [Windows](#windows-1)
18+
19+
## Official Installation Methods
20+
21+
### Debian and derivatives
1322

14-
## Alpine Linux
15-
16-
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):
23+
Download the `.deb` file from the [releases page][releases] and install with:
1724

18-
apk add git-interactive-rebase-tool
25+
sudo dpkg -i /path/to/git-interactive-rebase-tool-*.deb
1926

20-
## Arch Linux
27+
The executable will be installed to `/usr/bin`.
2128

22-
### With your [AUR](https://aur.archlinux.org/) helper of choice
29+
### Red Hat Linux, Fedora and derivatives
2330

24-
yay -S git-interactive-rebase-tool
31+
Download the `.rpm` file from the [releases page][releases] and install with your package manager of choice:
2532

26-
### Manual Install
33+
sudo rpm -i /path/to/git-interactive-rebase-tool-*.rpm
34+
sudo yum localinstall /path/to/git-interactive-rebase-tool-*.rpm
35+
sudo dnf localinstall /path/to/git-interactive-rebase-tool-*.rpm
2736

28-
1. Download the [package snapshot](https://aur.archlinux.org/packages/git-interactive-rebase-tool/)
29-
1. Extract to a known location
30-
1. Run `makepkg -si` from the extracted location
37+
### macOS
3138

32-
#### Troubleshooting
39+
#### With [Homebrew](https://brew.sh/)
3340

34-
If you receive the error, "no default toolchain configured", run `rustup default stable` and then retry the installation.
35-
This generally happens when `rustup` is installed without setting a default toolchain.
41+
brew install git-interactive-rebase-tool
3642

37-
### Remove
43+
#### Manual install
3844

39-
sudo pacman -R git-interactive-rebase-tool
45+
Download the macOS binary from the [releases page][releases] and copy it as `interactive-rebase-tool` to a location on your `PATH`.
4046

41-
## Cargo Package Manager
47+
#### Notes
4248

43-
cargo install git-interactive-rebase-tool
44-
45-
### Remove
49+
On macOS, Terminal.app does not support highlighting the selected line(s). If you want this feature you will need to use
50+
a terminal emulator like [iTerm2](https://iterm2.com/index.html).
4651

47-
cargo uninstall git-interactive-rebase-tool
52+
### Windows
4853

49-
## Debian and derivatives
54+
*Note: Windows binaries are not fully tested. If you are having issues please report them.*
5055

51-
Download the `.deb` file from the [releases page][releases] and install with:
56+
Download the tool from the [releases page][releases] and save it to a known location.
5257

53-
sudo dpkg -i /path/to/git-interactive-rebase-tool_*.deb
58+
### Alpine, Arch, and Raspberry Pi OS
5459

55-
The executable will be installed to `/usr/bin`.
60+
#### Manual Install
5661

57-
### Remove
62+
Download the binary from the [releases page][releases] and copy it as `interactive-rebase-tool` to a location on your `PATH`.
5863

59-
sudo dpkg -r git-interactive-rebase-tool
60-
61-
## Gnu Guix Package Manager
64+
## Cargo Package Manager (Most platforms)
6265

63-
guix install git-interactive-rebase-tool
66+
The project can be installed directly from [crates.io](https://crates.io/crates/git-interactive-rebase-tool) via cargo.
6467

65-
### Remove
68+
cargo install git-interactive-rebase-tool
6669

67-
guix remove git-interactive-rebase-tool
68-
69-
### In a temporary environment
70+
## Community Supported Repositories
7071

71-
guix shell git-interactive-rebase-tool
72-
73-
### In a temporary container (Linux namespace)
72+
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.
7473

75-
guix shell --container git-interactive-rebase-tool
74+
### Alpine Linux
7675

77-
## FreeBSD
76+
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):
7877

79-
### With [Ports](https://www.freebsd.org/ports/)
78+
apk add git-interactive-rebase-tool
8079

81-
#### Using pkg
80+
### Arch Linux
8281

83-
pkg install interactive_rebase_tool
82+
With your [AUR](https://aur.archlinux.org/) helper of choice:
8483

85-
#### Manual
84+
yay -S git-interactive-rebase-tool
8685

87-
cd /usr/ports/devel/interactive_rebase_tool && make install clean
86+
#### Manual Install
8887

89-
#### Remove
88+
1. Download the [package snapshot](https://aur.archlinux.org/packages/git-interactive-rebase-tool/)
89+
2. Extract to a known location
90+
3. Run `makepkg -si` from the extracted location
9091

91-
pkg remove interactive_rebase_tool
92+
### Gnu Guix Package Manager
9293

93-
## macOS
94+
guix install git-interactive-rebase-tool
9495

95-
### With [Homebrew](https://brew.sh/)
96+
#### In a temporary environment
9697

97-
brew install git-interactive-rebase-tool
98+
guix shell git-interactive-rebase-tool
9899

99-
#### Remove
100+
#### In a temporary container (Linux namespace)
100101

101-
brew rm git-interactive-rebase-tool
102+
guix shell --container git-interactive-rebase-tool
102103

103-
### Manual install
104+
### FreeBSD
104105

105-
Download the `macos-interactive-rebase-tool` from the [releases page][releases] and copy it as `interactive-rebase-tool`
106-
to a location on your `PATH`.
106+
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.
107107

108-
#### Remove
108+
With [Ports](https://www.freebsd.org/ports/) using `pkg`
109109

110-
Delete the copied `interactive-rebase-tool`.
110+
pkg install interactive_rebase_tool
111111

112-
### Notes
112+
#### Manual
113113

114-
On macOS, Terminal.app does not support highlighting the selected line(s). If you want this feature you will need to use
115-
a terminal emulator like [iTerm2](https://iterm2.com/index.html).
114+
cd /usr/ports/devel/interactive_rebase_tool && make install clean
116115

117-
## Windows
116+
### Windows
118117

119-
### With [Chocolatey](https://chocolatey.org/)
118+
#### With [Chocolatey](https://chocolatey.org/)
120119

121120
choco install git-interactive-rebase-tool
122121

123-
#### Remove
124-
125-
choco uninstall git-interactive-rebase-tool
126-
127-
### With [Scoop](https://scoop.sh/)
122+
#### With [Scoop](https://scoop.sh/)
128123

129124
scoop install git-interactive-rebase-tool
130125

131-
#### Remove
132-
133-
scoop uninstall git-interactive-rebase-tool
134-
135-
### Manual Install
136-
137-
*Note: Windows binaries are not fully tested. If you are having issues please report them.*
138-
139-
Download the tool from the [releases page][releases] and save it to a known location.
140-
141-
#### Remove
142-
143-
Delete the saved executable.
144-
145126
[releases]:https://github.com/MitMaro/git-interactive-rebase-tool/releases

0 commit comments

Comments
 (0)