Skip to content

Commit 0276455

Browse files
committed
Clarify README build instructions, Improve formatting
1 parent 4e38a94 commit 0276455

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

Diff for: README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -237,13 +237,13 @@ Normally the lazygit formula can be found in the Homebrew core but we suggest yo
237237

238238
Tap:
239239

240-
```
240+
```sh
241241
brew install jesseduffield/lazygit/lazygit
242242
```
243243

244244
Core:
245245

246-
```
246+
```sh
247247
brew install lazygit
248248
```
249249

@@ -432,23 +432,25 @@ You can install `lazygit` using the `winget` command in the Windows Terminal wit
432432
winget install -e --id=JesseDuffield.lazygit
433433
```
434434

435-
### Manual
435+
### Install Lazygit From Source
436436

437-
You'll need to [install Go](https://golang.org/doc/install)
437+
First, [install Go](https://golang.org/doc/install)
438438

439-
```
439+
```sh
440440
git clone https://github.com/jesseduffield/lazygit.git
441441
cd lazygit
442442
go install
443443
```
444444

445-
You can also use `go run main.go` to compile and run in one go (pun definitely intended)
445+
#### Compile Emphemeral Binary
446+
447+
Alternatively use `go run main.go` to compile and run in one go (pun definitely intended)
446448

447449
## Usage
448450

449-
Call `lazygit` in your terminal inside a git repository.
451+
Call `lazygit` in your terminal, while inside a git repository.
450452

451-
```sh
453+
```shell
452454
$ lazygit
453455
```
454456

@@ -464,7 +466,7 @@ You can check out the list of keybindings [here](/docs/keybindings).
464466

465467
If you change repos in lazygit and want your shell to change directory into that repo on exiting lazygit, add this to your `~/.zshrc` (or other rc file):
466468

467-
```
469+
```sh
468470
lg()
469471
{
470472
export LAZYGIT_NEW_DIR_FILE=~/.lazygit/newdir

0 commit comments

Comments
 (0)