summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTim Oram <dev@mitmaro.ca>2018-03-04 09:59:14 -0330
committerTim Oram <dev@mitmaro.ca>2018-03-04 09:59:14 -0330
commit47976472d85a390c102feca6a5c259059ccebfdf (patch)
tree748536f15bebad2b0bb0ae83e3616778568641dd
parent412c57c7bdf33cd8299119bf846505f6b8cbd2b8 (diff)
Improve install instructions
-rw-r--r--README.md26
1 files changed, 20 insertions, 6 deletions
diff --git a/README.md b/README.md
index 6d3c4ff..9b7fbac 100644
--- a/README.md
+++ b/README.md
@@ -13,24 +13,37 @@ Native cross platform full feature terminal based sequence editor for git intera
#### Debian and derivatives
+##### Install
+
Download the `.deb` file from the [releases page][releases] and install. The executable will be installed to `/usr/bin`.
+##### Configure Git
+
+ git config --global sequence.editor interactive-rebase-tool
+
#### MacOS and OSX
+##### Install
+
Download the `macos-git-interactive-rebase-tool` from the [releases page][releases] and copy it as
`interactive-rebase-tool` to a location on your `PATH`.
-#### Windows
+##### Configure Git
-Download the `macos-git-interactive-rebase-tool` from the [releases page][releases] and save it to a known location.
+ git config --global sequence.editor interactive-rebase-tool
-### Configure Git
+#### Windows
-For Linux and MacOS users in your command line run:
+*Note: Windows binaries are not fully tested. If you are having issues please report them.*
- git config --global sequence.editor interactive-rebase-tool
+##### Install
+
+Download the tool from the [releases page][releases] and save it to a known location. There are builds that use the GNU
+toolchain, tagged `gnu`, and builds that use the Microsoft toolchain, tagged `msvc`. There are 32 and 64 bit versions
+for each tool chain. If you are unsure which binary to download, you probably want the 64 bit Microsoft toolchain
+build.
-For Windows users:
+##### Configure Git
git config --global core.editor "'C:/path/to/interactive-rebase-tool'"
@@ -116,6 +129,7 @@ A deb file will be written to `target/debian/git-interactive-rebase-tool_*.deb`.
- [ ] Support for `exec` command
- [ ] Insert commit
+ - [ ] Configure key bindings
## Related Projects