Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2025-03-04 15:27:16 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs(README.md): update the readme

Browse source
This commit is contained in:
Kevin K 2015-03-26 14:20:01 -04:00
parent 726ef3f297
commit 6bed75a136
1 changed files with 15 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -127,10 +127,21 @@ You can also find full usage examples in the examples/ directory of this repo.
## How to build
### Running the tests
Clone the repo (`master` branch if using `clap`, `dev` branch if contributing) and build with Cargo
```
cargo test
git clone https://github.com/kbknapp/clap-rs
cd clap-rs
cargo build --release
```
### Running the tests
If contributing, you can run the tests as follows (assuming you've already cloned the repo to `clap-rs/`
```
cd clap-rs/claptests
make test
```
### Building the documentation
@ -140,3 +151,5 @@ Run this instead of `cargo doc` to generate the proper module docstring:
```
make doc
```
Then browse to `clap-rs/docs/index.html` in your web-browser of choice