Skip to content

Commit

Permalink
docs: make library and README consistent
Browse files Browse the repository at this point in the history
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
  • Loading branch information
joshka committed Sep 26, 2023
1 parent 301366c commit 4e5f4d9
Show file tree
Hide file tree
Showing 5 changed files with 769 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 4e5f4d9

Please sign in to comment.