Skip to content

Commit

Permalink
docs(generate): Improve jumping off points
Browse files Browse the repository at this point in the history
This provides a skeleton README for `clap_generate`, including a
one-line summary and a link to the docs to guide people to the examples
there.

In doing so, I tried to clarify and be consistent in what role
this crate plays.  While it is very general, being too general in the
description can lead people to not understand where they could use it.

Fixes #1711
  • Loading branch information
epage committed Aug 18, 2021
1 parent a4137d6 commit fa412c7
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
13 changes: 13 additions & 0 deletions clap_generate/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,14 @@
# clap_generate

[![Crates.io](https://img.shields.io/crates/v/clap_generate?style=flat-square)](https://crates.io/crates/clap_generate)
[![Crates.io](https://img.shields.io/crates/d/clap_generate?style=flat-square)](https://crates.io/crates/clap_generate)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](https://github.com/clap-rs/clap/blob/master/LICENSE-APACHE)
[![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](https://github.com/clap-rs/clap/blob/master/LICENSE-MIT)

Generates completions (and other things) for [`clap`](https://github.com/clap-rs/clap) based CLIs

* [Documentation][docs]
* [Questions & Discussions](https://github.com/clap-rs/clap/discussions)
* [Website](https://clap.rs/)

[docs]: https://docs.rs/clap_generate
4 changes: 2 additions & 2 deletions clap_generate/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
// See the [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) files in this repository
// for more information.

//! Generates stuff for [`clap`](https://github.com/clap-rs/clap) based CLIs
//! Generates completions (and other things) for [`clap`](https://github.com/clap-rs/clap) based CLIs

#![doc(html_logo_url = "https://clap.rs/images/media/clap.png")]
#![doc(html_root_url = "https://docs.rs/clap_generate/3.0.0-beta.4")]
Expand Down Expand Up @@ -36,7 +36,7 @@ pub use generators::Generator;
#[doc(inline)]
pub use shell::Shell;

/// Generate a file for a specified generator at compile time.
/// Generate a completions file for a specified shell at compile-time.
///
/// **NOTE:** to generate the file at compile time you must use a `build.rs` "Build Script"
///
Expand Down

0 comments on commit fa412c7

Please sign in to comment.