Skip to content
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.

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

docs: update README.md and add hello_world example #204

Merged
merged 1 commit into from
Jun 1, 2023

Conversation

joshka
Copy link
Member

@joshka joshka commented 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.

Direct link to view README:

@mindoodoo
Copy link
Member

Haven't looked too much at it, but looks good ! What do you think of maybe adding our logo somewhere at the top ?

@joshka joshka force-pushed the docs-readme branch 2 times, most recently from 4fef6b6 to a0d1140 Compare May 31, 2023 08:55
@joshka
Copy link
Member Author

joshka commented May 31, 2023

What do you think of maybe adding our logo somewhere at the top ?

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!

Copy link
Member

@mindoodoo mindoodoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM !

@mindoodoo mindoodoo added the Type: Documentation Improvements or additions to documentation label May 31, 2023
Copy link
Member

@orhun orhun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks pretty good! Just had a couple of comments about styling and a few recommendations.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
- 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.
@joshka
Copy link
Member Author

joshka commented Jun 1, 2023

Addressed all comments, added codecov.io badge

@orhun orhun merged commit b40ca44 into ratatui:main Jun 1, 2023
@joshka joshka deleted the docs-readme branch June 1, 2023 23:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants