Skip to content

Commit 717d6dd

Browse files
ccoVeilleMitMaro
authored andcommitted
chore: improve documentation style
1 parent d046e98 commit 717d6dd

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,9 @@ git config --global sequence.editor interactive-rebase-tool
137137
git config --global sequence.editor "'C:/path/to/interactive-rebase-tool.exe'"
138138
```
139139

140-
#### GitBash
140+
#### Git Bash
141141

142-
GitBash requires the use of `winpty` in order to work correctly, so to set the editor use:
142+
Git Bash requires the use of `winpty` in order to work correctly, so to set the editor use:
143143

144144
```shell
145145
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
326326
327327
#### Debian Packaging Building
328328
329-
cargo make build-deb
329+
```shell
330+
cargo make build-deb
331+
```
330332
331333
A deb file will be written to `target/debian/git-interactive-rebase-tool_*.deb`.
332334
333335
#### RPM Building
334336
335-
cargo make build-rpm
337+
```shell
338+
cargo make build-rpm
339+
```
336340
337341
A rpm file will be written to `target/generate-rpm/git-interactive-rebase-tool-*.deb`.
338342
339343
#### Reproducible Builds
340344
341-
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.
345+
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.
342346
343347
## Related Projects
344348
345349
* [rebase-editor](https://github.com/sjurba/rebase-editor) is a very similar project written in Node.js.
346-
* [cj-git-patchtool](https://github.com/pflanze/cj-git-patchtool) is another tool for doing git rebase en masse.
350+
* [cj-git-patchtool](https://github.com/pflanze/cj-git-patchtool) is another tool for doing `git rebase` en masse.
347351
* [andrewshadura/git-crecord](https://github.com/andrewshadura/git-crecord) provides interactive selection of changes to a commit.
348352
349353
## License

readme/customization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ Keys that do not have easily printable characters, such as the arrow keys, are s
183183

184184
### Modifier Keys
185185

186-
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.
186+
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.
187187

188188
### Multiple Key Bindings
189189

0 commit comments

Comments
 (0)