Skip to content

Commit 4902682

Browse files
author
Stephan Dilly
committed
more clean readme
1 parent 520456d commit 4902682

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,39 @@ blazing fast terminal-ui for git written in rust
1515

1616
![img](assets/demo.gif)
1717

18-
## features
18+
# features
1919

2020
* fast and intuitive key only control
2121
* context based help (**no** need to remember any hot-key)
22-
* inspect/commit changes (incl. hooks: commit-msg/post-commit)
23-
* (un)stage files, revert/reset files
22+
* inspect/commit changes (incl. hooks: *commit-msg*/*post-commit*)
23+
* (un)stage files/hunks, revert/reset files/hunk
2424
* scalable ui layout
2525
* async [input polling](assets/perf_compare.jpg) and
2626
* async git API for fluid control
2727

28-
## motivation
28+
# known limitations
29+
30+
* hooks don't work on windows
31+
* [core.hooksPath](https://git-scm.com/docs/githooks) config not supported
32+
* revert/reset hunk in working dir
33+
34+
# motivation
2935

3036
I do most of my git usage in a terminal but I frequently found myself using git UIs for some use cases like: index/commit, diff, stash and log.
3137

3238
Over the last 2 years my go-to GUI tool for this was [fork](https://git-fork.com) because it was not bloated, snappy and free. Unfortunately the *free* part will [change soon](https://github.com/ForkIssues/TrackerWin/issues/571) and so I decided to build a fast & simple terminal tool myself to copy the fork features i am using the most.
3339

34-
## installation
40+
# installation
41+
42+
For the time being this product is considered alpha and **not** production ready.
3543

36-
For the time being this product is considered alpha and not production ready, therefore I do not distribute binary versions yet, however feel free to build `gitui` and let me know what you think!
44+
## homebrew
45+
46+
```
47+
brew install extrawurst/tap/gitui
48+
```
49+
50+
## install from source
3751

3852
### requirements
3953

@@ -47,17 +61,13 @@ the simplest way to start playing around with `gitui` is to have `cargo` build/i
4761
cargo install gitui
4862
```
4963

50-
### diagnostics:
64+
# diagnostics:
5165

5266
to enable logging to `~/.gitui/gitui.log`:
5367
```
5468
GITUI_LOGGING=true gitui
5569
```
5670

57-
# todo for 0.2 (first release)
58-
59-
* [ ] publish as homebrew-tap
60-
6171
# inspiration
6272

6373
* https://github.com/jesseduffield/lazygit

0 commit comments

Comments
 (0)