From 7ca46bc708a8cfcbd9f3eb8c5221eccb4d621442 Mon Sep 17 00:00:00 2001 From: Markus Unterwaditzer Date: Thu, 19 Mar 2015 00:45:30 +0100 Subject: [PATCH] Add build instructions --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 53d22c20..de82278a 100644 --- a/README.md +++ b/README.md @@ -122,3 +122,19 @@ Add `extern crate clap;` to your crate root. ## More Information You can find complete documentation on the [github-pages site](http://kbknapp.github.io/clap-rs/docs/clap/index.html) for this project. + +## How to build + +### Running the tests + +``` +cargo test +``` + +### Building the documentation + +Run this instead of `cargo doc` to generate the proper module docstring: + +``` +make doc +```