cargo-readme-3.0.0
- cargo-readme 3.0.0
- Docs.rs crate page
- MIT OR Apache-2.0
- Links
- Repository
- Crates.io
- Source
- Owners
- livioribeiro
- webern
- Dependencies
- clap ^2.31
  lazy_static ^1.0
  percent-encoding ^1.0
  regex ^1.0
  serde ^1.0
  serde_derive ^1.0
  toml ^0.4
  assert_cli ^0.6
- Versions
Go to latest version
Platform
Feature flags

Rust

☰

Module project

Functions

Module cargo_readme::project[−][src]

Functions

find_entrypoint	Find the default entrypoiny to read the doc comments from
get_root	Get the project root from given path or defaults to current directory

Help

Keyboard Shortcuts

?: Show this help dialog
S: Focus the search field
↑: Move up in search results
↓: Move down in search results
↹: Switch tab
⏎: Go to active search result
+: Expand all sections
-: Collapse all sections

Search Tricks

Prefix searches with a type followed by a colon (e.g. fn:) to restrict the search to a given type.

Accepted types are: fn, mod, struct, enum, trait, type, macro, and const.

Search functions by type signature (e.g. vec -> usize or * -> vec)

Search multiple things at once by splitting your query with comma (e.g. str,u8 or String,struct:Vec,test)