Skip to content
This repository has been archived by the owner on Aug 23, 2022. It is now read-only.
/ clap-book Public archive

A book detailing how to build command line applications in Rust

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

clap-rs/clap-book

Repository files navigation

The Rust Programming Language

Build Status

This is the book “Building Command Line Utilities in Rust”, which is currently rendered online.

Requirements

Building the book requires mdBook >= v0.0.13. To get it:

$ cargo install mdbook

Building

To build the book, type:

$ mdbook build

The output will be in the book subdirectory. To check it out, open it in your web browser.

Firefox:

$ firefox book/index.html           # Linux
$ open -a "Firefox" book/index.html # OS X

Chrome:

$ google-chrome book/index.html           # Linux
$ open -a "Google Chrome" book/index.html # OS X

To run the tests:

$ mdbook test

Contributing

We'd love your help! Please see CONTRIBUTING.md.

Spellchecking

To scan source files for spelling errors, you can use the spellcheck.sh script. It needs a dictionary of valid words, which is provided in dictionary.txt. If the script produces a false positive (say, you used word BTreeMap which the script considers invalid), you need to add this word to dictionary.txt (keep the sorted order for consistency).

Converting Windows newlines to Unix

This is mostly for Carol's reference because she keeps having to look it up.

$ tr -d '\015' < DOS-file > UNIX-file

About

A book detailing how to build command line applications in Rust

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages