Added example to README
This commit is contained in:
parent
04d090fee9
commit
fd17aeaf0a
1 changed files with 12 additions and 3 deletions
15
README.md
15
README.md
|
|
@ -1,9 +1,6 @@
|
||||||
# gitredux
|
# gitredux
|
||||||
###This project is nascent and in a state of flux!
|
###This project is nascent and in a state of flux!
|
||||||
|
|
||||||
I started this project because `git log --no-pager` gives an error. Apparently I wanted `git --no-pager log`. This was the last straw.
|
|
||||||
*So I decided to "fix" the git CLI.*
|
|
||||||
|
|
||||||
This project takes inspiration from [gitless](http://gitless.com/) and [legit](https://github.com/kennethreitz/legit), and is
|
This project takes inspiration from [gitless](http://gitless.com/) and [legit](https://github.com/kennethreitz/legit), and is
|
||||||
influenced by this [blog post](http://www.saintsjd.com/2012/01/a-better-ui-for-git/) and this [fantastic diatribe](http://stevebennett.me/2012/02/24/10-things-i-hate-about-git).
|
influenced by this [blog post](http://www.saintsjd.com/2012/01/a-better-ui-for-git/) and this [fantastic diatribe](http://stevebennett.me/2012/02/24/10-things-i-hate-about-git).
|
||||||
However, I feel all of these tools are either underdeveloped or too opinionated. I want a tool that gives me all the
|
However, I feel all of these tools are either underdeveloped or too opinionated. I want a tool that gives me all the
|
||||||
|
|
@ -14,6 +11,18 @@ same control as git but without the headache of its impossible to remember comma
|
||||||
* Fewer, more orthogonal commands
|
* Fewer, more orthogonal commands
|
||||||
* More useful (and non-destructive) default behaviors
|
* More useful (and non-destructive) default behaviors
|
||||||
|
|
||||||
|
### Why?
|
||||||
|
I started this project because `git log --no-pager` gives an error. Apparently I wanted `git --no-pager log`. This was the last straw.
|
||||||
|
*So I decided to "fix" the git CLI.*
|
||||||
|
|
||||||
|
EDIT: Even better example of inanity of git CLI: To get the SHA reference of HEAD, do you use `git show-ref HEAD --abbrev --hash` or `git rev-parse --short HEAD`?
|
||||||
|
|
||||||
|
* Why are they different results?
|
||||||
|
* Why does `show-ref` use `--abbrev` but `rev-parse` use `--short`?
|
||||||
|
* Why are the options _after_ `HEAD` in `show-ref` but _before_ `HEAD` in `rev-parse`?
|
||||||
|
* I leave answering these questions as an exercise to the reader.
|
||||||
|
|
||||||
|
|
||||||
### Commands
|
### Commands
|
||||||
(bound to get out of date quickly)
|
(bound to get out of date quickly)
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue