docs: make library and README consistent #526
Merged
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
joshka
requested review from
orhun,
mindoodoo,
sayanarijit,
sophacles and
kdheepak
as code owners
Codecov Report
@@ Coverage Diff @@
## main #526 +/- ##
=======================================
Coverage 89.65% 89.65%
=======================================
Files 41 41
Lines 11437 11437
=======================================
Hits 10254 10254
Misses 1183 1183 |
Outdated
|
|
ping @1oglop1 |
kdheepak
reviewed
Sep 22, 2023
|
With discussed tweaks (rebased on the frame PR): |
kdheepak
reviewed
Sep 23, 2023
kdheepak
previously approved these changes
Sep 23, 2023
joshka
force-pushed
the
cargo-rdme
branch
2 times, most recently
from
5460ac5 to
4e5f4d9
Compare
Generate the bulk of the README from the library documentation, so that they are consistent using cargo-rdme. - Removed the Contributors section, as it is redundant with the github contributors list. - Removed the info about the other backends and replaced it with a pointer to the documentation. - add docsrs example, vhs tape and images that will end up in the README Fixes: #512
|
Rebased to address lib.rs conflicts, squashed and updated commit message. |
kdheepak
approved these changes
Sep 28, 2023
tonogdlp
pushed a commit
to tonogdlp/ratatui
that referenced
this pull request
Oct 6, 2023
* docs: make library and README consistent Generate the bulk of the README from the library documentation, so that they are consistent using cargo-rdme. - Removed the Contributors section, as it is redundant with the github contributors list. - Removed the info about the other backends and replaced it with a pointer to the documentation. - add docsrs example, vhs tape and images that will end up in the README Fixes: ratatui#512
3 tasks
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.
Generate the bulk of the README from the library documentation, so that
they are consistent using cargo-rdme.
github contributors list.
pointer to the documentation.
Fixes: #512