go/lazygit
1
0
Fork 0
mirror of https://github.com/jesseduffield/lazygit.git synced 2025-05-17 22:32:58 +02:00
Code Issues Releases Activity

docs: Minor formatting fixes for README.md

Browse Source 
Running 'mdformat' on README.md adds and removes a few line breaks to improve
readability. Also, '$' doesn't need to be escaped.
This commit is contained in:
Moritz Haase 2022-03-15 08:14:13 +01:00 committed by Jesse Duffield
parent eb182abf48
commit c9f1a40ffa
1 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -2,10 +2,7 @@
<img src="https://i.imgur.com/oYB7Cj8.png"> <img src="https://i.imgur.com/oYB7Cj8.png">
</p> </p>
![CI](https://github.com/jesseduffield/lazygit/workflows/Continuous%20Integration/badge.svg) [![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)]() [![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/jesseduffield/lazygit)](https://www.tickgit.com/browse?repo=github.com/jesseduffield/lazygit) ![CI](https://github.com/jesseduffield/lazygit/workflows/Continuous%20Integration/badge.svg) [![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)](<>) [![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/jesseduffield/lazygit)](https://www.tickgit.com/browse?repo=github.com/jesseduffield/lazygit)
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.
@ -157,7 +154,6 @@ sudo emerge dev-vcs/lazygit
pkg install lazygit pkg install lazygit
``` ```
### 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>
@ -174,7 +170,7 @@ go install github.com/jesseduffield/lazygit@latest
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 mistaken for `C:\Go\bin` (which is for Go's own binaries, (Windows). Not to be mistaken for `C:\Go\bin` (which is for Go's own binaries,
not apps like lazygit). not apps like lazygit).
@ -258,7 +254,6 @@ See the [docs](docs/Custom_Command_Keybindings.md)
- [Rebase Magic Video Tutorial](https://youtu.be/4XaToVut_hs) - [Rebase Magic Video Tutorial](https://youtu.be/4XaToVut_hs)
- [Twitch Stream](https://www.twitch.tv/jesseduffield) - [Twitch Stream](https://www.twitch.tv/jesseduffield)
## Cool features ## Cool features
- Adding files easily - Adding files easily
@ -284,6 +279,7 @@ For contributor discussion about things not better discussed here in the repo, j
[![Slack](../assets/slack_rgb.png)](https://join.slack.com/t/lazygit/shared_invite/zt-5bo2clzo-hB8ZTVN5dWUCqj5QFiQVLA) [![Slack](../assets/slack_rgb.png)](https://join.slack.com/t/lazygit/shared_invite/zt-5bo2clzo-hB8ZTVN5dWUCqj5QFiQVLA)
### Debugging Locally ### Debugging Locally
Run `lazygit --debug` in one terminal tab and `lazygit --logs` in another to view the program and its log output side by side Run `lazygit --debug` in one terminal tab and `lazygit --logs` in another to view the program and its log output side by side
## Donate ## Donate
@ -293,6 +289,7 @@ If you would like to support the development of lazygit, consider [sponsoring me
## FAQ ## FAQ
### I'm struggling to see the selected line ### I'm struggling to see the selected line
see [here](https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#struggling-to-see-selected-line) see [here](https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#struggling-to-see-selected-line)
## Social ## Social