Skip to content

Commit

Permalink
Auto merge of #749 - tshepang:nits, r=kbknapp
Browse files Browse the repository at this point in the history
doc: some formatting fixes
  • Loading branch information
homu committed Nov 14, 2016
2 parents fb4214f + 4744d07 commit 4181a98
Showing 1 changed file with 23 additions and 12 deletions.
35 changes: 23 additions & 12 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -277,16 +277,22 @@
//!
//! ### BYOB (Build Your Own Binary)
//!
//! To test out `clap`'s default auto-generated help/version follow these steps:
//! * Create a new cargo project `$ cargo new fake --bin && cd fake`
//! * Add `clap` to your `Cargo.toml`
//! *
//! ```toml
//! [dependencies]
//! clap = "2"
//! ```
//! To test `clap`'s default auto-generated help/version, follow these steps:
//!
//! * Create a new cargo project:
//!
//! * Add the following to your `src/main.rs`
//! ```ignore
//! cargo new fake --bin && cd fake
//! ```
//!
//! * Add `clap` to your `Cargo.toml`:
//!
//! ```toml
//! [dependencies]
//! clap = "2"
//! ```
//!
//! * Add the following to your `src/main.rs`:
//!
//! ```no_run
//! extern crate clap;
Expand All @@ -297,8 +303,13 @@
//! }
//! ```
//!
//! * Build your program `$ cargo build --release`
//! * Run with help or version `$ ./target/release/fake --help` or `$ ./target/release/fake --version`
//! * Build your program, then run it:
//!
//! ```ignore
//! cargo build --release
//! ./target/release/fake --help
//! ./target/release/fake --version
//! ```
//!
//! ## Usage
//!
Expand Down Expand Up @@ -444,4 +455,4 @@ mod completions;

const INTERNAL_ERROR_MSG: &'static str = "Fatal internal error. Please consider filing a bug \
report at https://github.com/kbknapp/clap-rs/issues";
const INVALID_UTF8: &'static str = "unexpected invalid UTF-8 code point";
const INVALID_UTF8: &'static str = "unexpected invalid UTF-8 code point";

0 comments on commit 4181a98

Please sign in to comment.