Skip to content

Update Readme for clarity #838

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ColbyJohnson wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Readme for clarity #838

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 36 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,13 +110,20 @@ Or just install it with `go`:
go install github.com/charmbracelet/glow/v2@latest
```

### Build (requires Go 1.21+)
## Quickstart

Requirements: Go 1.21+.

```bash
git clone https://github.com/charmbracelet/glow.git
cd glow
go build
```
go version # confirm >= 1.21
go build # produces ./glow
./glow # TUI: browse Markdown in the current repo/dir
./glow README.md # render a single file

### Build (requires Go 1.21+)


[releases]: https://github.com/charmbracelet/glow/releases

Expand Down Expand Up @@ -214,13 +221,29 @@ showLineNumbers: false
# preserve newlines in the output
preserveNewLines: false
```
## Keybindings (TUI)

| Action | Key |
|---|---|
| Quit | `q` |
| Up/Down | `↑ / ↓` |
| Page Up/Down | `PgUp / PgDn` |
| Open Link | `Enter` |

## Contributing

See [contributing][contribute].

[contribute]: https://github.com/charmbracelet/glow/contribute

## Testing

Runs all packages with go

```bash
go test .
```

## Feedback

We’d love to hear your thoughts on this project. Feel free to drop us a note!
Expand All @@ -229,6 +252,16 @@ We’d love to hear your thoughts on this project. Feel free to drop us a note!
- [The Fediverse](https://mastodon.social/@charmcli)
- [Discord](https://charm.sh/chat)


---

## Troubleshooting

- **Build fails:** Confirm `go version` is ≥ 1.21, then `go clean -modcache && go mod tidy`.
- **“Undefined symbols when testing:** Use `go test .`, not `go test file_test.go`.
- **No files in TUI:** Run `glow` from a directiory actually containing Markdown or a git repo; try `glow README.md` to verify/


## License

[MIT](https://github.com/charmbracelet/glow/raw/master/LICENSE)
Expand Down