Update Readme for clarity #838
Open
+36
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ColbyJohnson
requested review from
andreynering and
tauraamui
and removed request for
a team
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This request updates the README.md to make it easier for new users and contributors to build, explore, and test. Specifically, I added a new Quickstart section that provides a short, copy + paste guide for cloning, versioning, and building and executing Glow. I also included aTests section that explains how to correctly execute the test suite using go test . to avoid common errors such as undefined: pager, style, etc...
I created a bindings (TUI) table that highlights keyboard shortcuts so users can more easily navigate the terminal. Finally, I added a Troubleshooting section that covers common setup and runtime problems.
I verified that all new instructions work by running the build and test commands locally on go 1.22 and confirmed that the new sections render properly.