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

Update README to use ratatui #446

Merged
merged 1 commit into from
Aug 29, 2023
Merged

Update README to use ratatui #446

merged 1 commit into from
Aug 29, 2023

Conversation

kdheepak
Copy link
Collaborator

@kdheepak kdheepak commented Aug 28, 2023

In my opinion, this change in the docs will be a better user experience for most people, for the following reasons:

  • With breaking changes users can't just do this to upgrade from tui:
[dependencies]
tui = { package = "ratatui", version = "0.23.0", features = ["all-widgets"]} # will cause errors because of breaking changes going forward

At best, we should only recommend this:

[dependencies]
tui = { package = "ratatui", version = "0.19.0", features = ["all-widgets"]}

But I think we should save that for the docs or the ratatui-book; and the README should have one obvious way for newcomers to add the ratatui crate to their project.

  • Third party crates linked have migrated from tui to ratatui.

  • If users use ratatui explicitly in the code, it'll will allow for searching for ratatui on github / gitlab etc to be easier going forward.

@codecov
Copy link

codecov bot commented Aug 28, 2023

Codecov Report

Merging #446 (905fe7a) into main (3f781ca) will not change coverage.
The diff coverage is n/a.

❗ Current head 905fe7a differs from pull request most recent head ff7d496. Consider uploading reports for the commit ff7d496 to get more accurate results

@@           Coverage Diff           @@
##             main     #446   +/-   ##
=======================================
  Coverage   90.42%   90.42%           
=======================================
  Files          40       40           
  Lines       11079    11079           
=======================================
  Hits        10018    10018           
  Misses       1061     1061           

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.

+1

Copy link
Member

@Valentin271 Valentin271 left a comment

Choose a reason for hiding this comment

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

+1 too

@joshka
Copy link
Member

joshka commented Aug 28, 2023

@kdheepak looks like your gpg signing was broken. Pushing a rebase should in theory allow this to merge.

@kdheepak kdheepak added this pull request to the merge queue Aug 29, 2023
Merged via the queue into main with commit eda2fb7 Aug 29, 2023
@kdheepak kdheepak deleted the update-docs branch August 29, 2023 01:41
@kdheepak
Copy link
Collaborator Author

Thanks for catching that! It looks like I'll need to set up a post-commit gpg signing check :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants