diff options
| author | ccoVeille <3875889+ccoVeille@users.noreply.github.com> | 2024-07-05 09:47:59 +0200 |
|---|---|---|
| committer | Tim Oram <dev@mitmaro.ca> | 2024-07-05 07:08:02 -0400 |
| commit | 717d6dd71b2884b3bce0c4f24fa474181701595b (patch) | |
| tree | 613e750f5ef4b72d83f42f0eec11ce3fd48ecd4e | |
| parent | d046e9856c2495a6bd3f9d48a619328f788e1383 (diff) | |
chore: improve documentation style
| -rw-r--r-- | README.md | 16 | ||||
| -rw-r--r-- | readme/customization.md | 2 |
2 files changed, 11 insertions, 7 deletions
@@ -137,9 +137,9 @@ git config --global sequence.editor interactive-rebase-tool git config --global sequence.editor "'C:/path/to/interactive-rebase-tool.exe'" ``` -#### GitBash +#### Git Bash -GitBash requires the use of `winpty` in order to work correctly, so to set the editor use: +Git Bash requires the use of `winpty` in order to work correctly, so to set the editor use: ```shell git config --global sequence.editor "winpty /c/path/to/interactive-rebase-tool.exe" @@ -326,24 +326,28 @@ An addition to the report printed to the CLI, an HTML report can be found in the #### Debian Packaging Building - cargo make build-deb +```shell +cargo make build-deb +``` A deb file will be written to `target/debian/git-interactive-rebase-tool_*.deb`. #### RPM Building - cargo make build-rpm +```shell +cargo make build-rpm +``` A rpm file will be written to `target/generate-rpm/git-interactive-rebase-tool-*.deb`. #### Reproducible Builds -Providing a [`SOURCE_DATE_EPOCH`](https://reproducible-builds.org/specs/source-date-epoch/#idm55) environment variable with a valid UNIX timestamp, defined in seconds, will ensure a reproducible build. +Providing a [`SOURCE_DATE_EPOCH`](https://reproducible-builds.org/specs/source-date-epoch/#idm55) environment variable with a valid Unix timestamp, defined in seconds, will ensure a reproducible build. ## Related Projects * [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. +* [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/customization.md b/readme/customization.md index 91d8447..c57573d 100644 --- a/readme/customization.md +++ b/readme/customization.md @@ -183,7 +183,7 @@ Keys that do not have easily printable characters, such as the arrow keys, are s ### Modifier Keys -Most bindings can be prefixed with `Shift`, `Control` or `Alt`, followed by a `+`. These bindings can also be combined in any order, for example `Alt+Control+Delete`. `Shift` combined with any ASCII alphabetic character will not work and the uppercase character must be used instead. +Most bindings can be prefixed with `Shift`, `Control` or `Alt`, followed by a `+`. These bindings can also be combined in any order, for example `Alt+Control+Delete`. `Shift` combined with any ASCII alphabetical character will not work, and the uppercase character must be used instead. ### Multiple Key Bindings |