docs: update README.md and add hello_world example #204
Conversation
This file contains 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
|
Haven't looked too much at it, but looks good ! What do you think of maybe adding our logo somewhere at the top ? |
sayanarijit
approved these changes
May 31, 2023
joshka
force-pushed
the
docs-readme
branch
2 times, most recently
from
4fef6b6
to
a0d1140
Compare
Done! https://github.com/tui-rs-revival/ratatui/blob/a0d1140384c01d713c20074f75756cc32d4d51ad/README.md I also shuffled the badge order just a little. I think the logo makes it look pretty nice. Props to @nawok! |
orhun
reviewed
May 31, 2023
- Reformat summary info - Add badges for dependencies, discord, license - point existing badges to shields.io - add Table of Contents - tweaked installation instructions to show instructions for new and existing crates - moved fork status lower - chop lines generally to 100 limit - add a quickstart based on a simplified hello_world example - added / updated some internal links to point locally - removed some details to simplify the readme (e.g. tick-rate) - reordered widgets and pointed these at the widget docs - adds a hello_world example that has just the absolute basic code necessary to run a ratatui app. This includes some comments that help guide the user towards other approaches and considerations for a real world app.
|
Addressed all comments, added codecov.io badge |
orhun
approved these changes
Jun 1, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
existing crates
necessary to run a ratatui app. This includes some comments that help
guide the user towards other approaches and considerations for a real
world app.
Direct link to view README: