Skip to content

Commit a253b0b

Browse files
committed
2 parents 5ca47c3 + 456c593 commit a253b0b

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,20 @@ Are YOU tired of typing every git command directly into the terminal, but you're
99
![Gif](https://image.ibb.co/mmeXho/optimisedgif.gif)
1010

1111
## Installation
12+
13+
### Via binary release
14+
You can download a binary release [here](https://github.com/jesseduffield/lazygit/releases)
15+
You may need to grant execute permission via `chmod +x ./<filename>`.
16+
You can move this file to your local /bin directory and rename to `lazygit` so that you can run it anywhere
17+
(Easier-install coming soon)
18+
19+
### Via Go
1220
In a terminal call this command:
1321
`go get github.com/jesseduffield/lazygit`
1422
(if you don't have Go installed, you can follow the installation guide [here](https://golang.org/doc/install).
1523

16-
Then just call `lazygit` in your terminal inside a git repository.
17-
18-
If you want, you can also add an alias for this with `echo "alias lg='lazygit'" >> ~/.zshrc` (or whichever rc file you're using).
19-
2024
Please note:
21-
If you get an error claiming that lazygit cannot be found or is not defined, you may need to add `~/go/bin` to your $PATH (MacOS/Linux), or `%HOME%\go\bin` (Windows)
25+
If you get an error claiming that lazygit cannot be found or is not defined, you may need to add `~/go/bin` to your $PATH (MacOS/Linux), or `%HOME%\go\bin` (Windows). Not to be mistaked for `C:\Go\bin` (which is for Go's own binaries, not apps like Lazygit)
2226

2327
### Ubuntu
2428
Packages for Ubuntu 16.04 and up are available via Launchpad PPA.
@@ -31,6 +35,13 @@ sudo apt-get update
3135
sudo apt-get install lazygit
3236
```
3337

38+
39+
## Usage
40+
Call `lazygit` in your terminal inside a git repository.
41+
If you want, you can also add an alias for this with `echo "alias lg='lazygit'" >> ~/.zshrc` (or whichever rc file you're using).
42+
Basic tutorial [Here](https://www.youtube.com/watch?v=VDXvbHZYeKY)
43+
[Keybindings](https://github.com/jesseduffield/lazygit/blob/master/docs/Keybindings.md)
44+
3445
## Cool features
3546
- Adding files easily
3647
- Resolving merge conflicts
@@ -45,14 +56,12 @@ sudo apt-get install lazygit
4556
### Viewing commit diffs
4657
![Viewing Commit Diffs](https://image.ibb.co/gPD02o/capture.png)
4758

48-
## Docs
49-
[Keybindings](https://github.com/jesseduffield/lazygit/blob/master/docs/Keybindings.md)
50-
5159
## Milestones
5260
- [ ] Easy Installation (homebrew, release binaries)
5361
- [ ] Configurable Keybindings
5462
- [ ] Configurable Color Themes
5563
- [ ] Spawning Subprocesses (help needed - have a look at https://github.com/jesseduffield/lazygit/pull/18)
64+
- [ ] Maintainability
5665
- [ ] Performance
5766
- [ ] i18n
5867

0 commit comments

Comments
 (0)