Skip to content

Commit

Permalink
docs: make library and README consistent (ratatui-org#526)
Browse files Browse the repository at this point in the history
* 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-org#512
  • Loading branch information
joshka authored and test committed Oct 6, 2023
1 parent 52338c4 commit d241ca6
Show file tree
Hide file tree
Showing 5 changed files with 781 additions and 295 deletions.
5 changes: 5 additions & 0 deletions Cargo.toml
Expand Up @@ -155,6 +155,11 @@ name = "demo2"
required-features = ["crossterm", "widget-calendar"]
doc-scrape-examples = true

[[example]]
name = "docsrs"
required-features = ["crossterm"]
doc-scrape-examples = false

[[example]]
name = "gauge"
required-features = ["crossterm"]
Expand Down

0 comments on commit d241ca6

Please sign in to comment.