1
0
mirror of https://github.com/jesseduffield/lazygit.git synced 2025-02-09 13:47:11 +02:00

update readme with new keybindings link

This commit is contained in:
Jesse Duffield 2019-03-03 23:44:50 +11:00
parent 1184990e16
commit 038dcb546e

View File

@ -1,31 +1,32 @@
# lazygit [![CircleCI](https://circleci.com/gh/jesseduffield/lazygit.svg?style=svg)](https://circleci.com/gh/jesseduffield/lazygit) [![codecov](https://codecov.io/gh/jesseduffield/lazygit/branch/master/graph/badge.svg)](https://codecov.io/gh/jesseduffield/lazygit) [![Go Report Card](https://goreportcard.com/badge/github.com/jesseduffield/lazygit)](https://goreportcard.com/report/github.com/jesseduffield/lazygit) [![GolangCI](https://golangci.com/badges/github.com/jesseduffield/lazygit.svg)](https://golangci.com) [![GoDoc](https://godoc.org/github.com/jesseduffield/lazygit?status.svg)](http://godoc.org/github.com/jesseduffield/lazygit) [![GitHub tag](https://img.shields.io/github/tag/jesseduffield/lazygit.svg)]() # lazygit [![CircleCI](https://circleci.com/gh/jesseduffield/lazygit.svg?style=svg)](https://circleci.com/gh/jesseduffield/lazygit) [![codecov](https://codecov.io/gh/jesseduffield/lazygit/branch/master/graph/badge.svg)](https://codecov.io/gh/jesseduffield/lazygit) [![Go Report Card](https://goreportcard.com/badge/github.com/jesseduffield/lazygit)](https://goreportcard.com/report/github.com/jesseduffield/lazygit) [![GolangCI](https://golangci.com/badges/github.com/jesseduffield/lazygit.svg)](https://golangci.com) [![GoDoc](https://godoc.org/github.com/jesseduffield/lazygit?status.svg)](http://godoc.org/github.com/jesseduffield/lazygit) [![GitHub tag](https://img.shields.io/github/tag/jesseduffield/lazygit.svg)]()
A simple terminal UI for git commands, written in Go with the [gocui](https://github.com/jroimartin/gocui "gocui") library. A simple terminal UI for git commands, written in Go with the [gocui](https://github.com/jroimartin/gocui 'gocui') library.
Are YOU tired of typing every git command directly into the terminal, but you're Are YOU tired of typing every git command directly into the terminal, but you're
too stubborn to use Sourcetree because you'll never forgive Atlassian for making too stubborn to use Sourcetree because you'll never forgive Atlassian for making
Jira? This is the app for you! Jira? This is the app for you!
![Gif](/docs/resources/lazygit-example.gif) ![Gif](/docs/resources/lazygit-example.gif)
* [Installation](https://github.com/jesseduffield/lazygit#installation) - [Installation](https://github.com/jesseduffield/lazygit#installation)
* [Usage](https://github.com/jesseduffield/lazygit#usage), - [Usage](https://github.com/jesseduffield/lazygit#usage),
[Keybindings](https://github.com/jesseduffield/lazygit/blob/master/docs/Keybindings.md) [Keybindings](https://github.com/jesseduffield/lazygit/blob/master/docs/Keybindings_en.md)
* [Cool Features](https://github.com/jesseduffield/lazygit#cool-features) - [Cool Features](https://github.com/jesseduffield/lazygit#cool-features)
* [Contributing](https://github.com/jesseduffield/lazygit#contributing) - [Contributing](https://github.com/jesseduffield/lazygit#contributing)
* [Video Tutorial](https://youtu.be/VDXvbHZYeKY) - [Video Tutorial](https://youtu.be/VDXvbHZYeKY)
* [Twitch Stream](https://www.twitch.tv/jesseduffield) - [Twitch Stream](https://www.twitch.tv/jesseduffield)
## Installation ## Installation
### Homebrew ### Homebrew
```sh ```sh
brew tap jesseduffield/lazygit brew tap jesseduffield/lazygit
brew install lazygit brew install lazygit
``` ```
### Ubuntu ### Ubuntu
Packages for Ubuntu 16.04, 18.04 and 18.10 are available via [Launchpad PPA](https://launchpad.net/~lazygit-team). Packages for Ubuntu 16.04, 18.04 and 18.10 are available via [Launchpad PPA](https://launchpad.net/~lazygit-team).
**Release builds** **Release builds**
@ -49,6 +50,7 @@ sudo apt-get install lazygit
``` ```
### Void Linux ### Void Linux
Packages for Void Linux are available in the distro repo Packages for Void Linux are available in the distro repo
They follow upstream latest releases They follow upstream latest releases
@ -58,61 +60,71 @@ sudo xbps-install -S lazygit
``` ```
### Arch Linux ### Arch Linux
Packages for Arch Linux are available via AUR (Arch User Repository). Packages for Arch Linux are available via AUR (Arch User Repository).
There are two packages. The stable one which is built with the latest release There are two packages. The stable one which is built with the latest release
and the git version which builds from the most recent commit. and the git version which builds from the most recent commit.
* Stable: https://aur.archlinux.org/packages/lazygit/ - Stable: https://aur.archlinux.org/packages/lazygit/
* Development: https://aur.archlinux.org/packages/lazygit-git/ - Development: https://aur.archlinux.org/packages/lazygit-git/
Instruction of how to install AUR content can be found here: Instruction of how to install AUR content can be found here:
https://wiki.archlinux.org/index.php/Arch_User_Repository https://wiki.archlinux.org/index.php/Arch_User_Repository
### Conda ### Conda
Released versions are available for different platforms, see https://anaconda.org/conda-forge/lazygit Released versions are available for different platforms, see https://anaconda.org/conda-forge/lazygit
```sh ```sh
conda install -c conda-forge lazygit conda install -c conda-forge lazygit
``` ```
### Binary Release (Windows/Linux/OSX) ### Binary Release (Windows/Linux/OSX)
You can download a binary release [here](https://github.com/jesseduffield/lazygit/releases). You can download a binary release [here](https://github.com/jesseduffield/lazygit/releases).
### Go ### Go
```sh ```sh
go get github.com/jesseduffield/lazygit go get github.com/jesseduffield/lazygit
``` ```
Please note: Please note:
If you get an error claiming that lazygit cannot be found or is not defined, you 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` 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, (Windows). Not to be mistaked for `C:\Go\bin` (which is for Go's own binaries,
not apps like Lazygit). not apps like Lazygit).
## Usage ## Usage
Call `lazygit` in your terminal inside a git repository. If you want, you can Call `lazygit` in your terminal inside a git repository. If you want, you can
also add an alias for this with `echo "alias lg='lazygit'" >> ~/.zshrc` (or also add an alias for this with `echo "alias lg='lazygit'" >> ~/.zshrc` (or
whichever rc file you're using). whichever rc file you're using).
* Basic video tutorial [here](https://youtu.be/VDXvbHZYeKY). - Basic video tutorial [here](https://youtu.be/VDXvbHZYeKY).
* List of keybindings - List of keybindings
[here](/docs/Keybindings.md). [here](/docs/Keybindings.md).
## Cool features ## Cool features
* Adding files easily
* Resolving merge conflicts - Adding files easily
* Easily check out recent branches - Resolving merge conflicts
* Scroll through logs/diffs of branches/commits/stash - Easily check out recent branches
* Quick pushing/pulling - Scroll through logs/diffs of branches/commits/stash
* Squash down and rename commits - Quick pushing/pulling
- Squash down and rename commits
### Resolving merge conflicts ### Resolving merge conflicts
![Gif](/docs/resources/resolving-merge-conflicts.gif) ![Gif](/docs/resources/resolving-merge-conflicts.gif)
### Viewing commit diffs ### Viewing commit diffs
![Viewing Commit Diffs](/docs/resources/viewing-commit-diffs.png) ![Viewing Commit Diffs](/docs/resources/viewing-commit-diffs.png)
## Milestones ## Milestones
- [x] Easy Installation (homebrew, release binaries) - [x] Easy Installation (homebrew, release binaries)
- [ ] Configurable Keybindings - [ ] Configurable Keybindings
- [ ] Configurable Color Themes - [ ] Configurable Color Themes
@ -122,27 +134,33 @@ whichever rc file you're using).
- [ ] i18n - [ ] i18n
## Contributing ## Contributing
We love your input! Please check out the [contributing guide](CONTRIBUTING.md). We love your input! Please check out the [contributing guide](CONTRIBUTING.md).
For contributor discussion about things not better discussed here in the repo, join the slack channel For contributor discussion about things not better discussed here in the repo, join the slack channel
[![Slack](/docs/resources/slack_rgb.png)](https://join.slack.com/t/lazygit/shared_invite/enQtNDE3MjIwNTYyMDA0LTM3Yjk3NzdiYzhhNTA1YjM4Y2M4MWNmNDBkOTI0YTE4YjQ1ZmI2YWRhZTgwNjg2YzhhYjg3NDBlMmQyMTI5N2M) [![Slack](/docs/resources/slack_rgb.png)](https://join.slack.com/t/lazygit/shared_invite/enQtNDE3MjIwNTYyMDA0LTM3Yjk3NzdiYzhhNTA1YjM4Y2M4MWNmNDBkOTI0YTE4YjQ1ZmI2YWRhZTgwNjg2YzhhYjg3NDBlMmQyMTI5N2M)
## Donate ## Donate
If you would like to support the development of lazygit, please donate If you would like to support the development of lazygit, please donate
[![Donate](https://d1iczxrky3cnb2.cloudfront.net/button-medium-blue.png)](https://donorbox.org/lazygit) [![Donate](https://d1iczxrky3cnb2.cloudfront.net/button-medium-blue.png)](https://donorbox.org/lazygit)
## Work in progress ## Work in progress
This is still a work in progress so there's still bugs to iron out and as this This is still a work in progress so there's still bugs to iron out and as this
is my first project in Go the code could no doubt use an increase in quality, is my first project in Go the code could no doubt use an increase in quality,
but I'll be improving on it whenever I find the time. If you have any feedback but I'll be improving on it whenever I find the time. If you have any feedback
feel free to [raise an issue](https://github.com/jesseduffield/lazygit/issues)/[submit a PR](https://github.com/jesseduffield/lazygit/pulls). feel free to [raise an issue](https://github.com/jesseduffield/lazygit/issues)/[submit a PR](https://github.com/jesseduffield/lazygit/pulls).
## Social ## Social
If you want to see what I (Jesse) am up to in terms of development, follow me on If you want to see what I (Jesse) am up to in terms of development, follow me on
[twitter](https://twitter.com/DuffieldJesse) or watch me program on [twitter](https://twitter.com/DuffieldJesse) or watch me program on
[twitch](https://www.twitch.tv/jesseduffield). [twitch](https://www.twitch.tv/jesseduffield).
## Alternatives ## Alternatives
If you find that lazygit doesn't quite satisfy your requirements, these may be a better fit: If you find that lazygit doesn't quite satisfy your requirements, these may be a better fit:
- [tig](https://github.com/jonas/tig) - [tig](https://github.com/jonas/tig)