From afa2cfb546b394ffdc64613d9c9c891ccae08a7a Mon Sep 17 00:00:00 2001 From: Jeremy Wall Date: Fri, 17 Aug 2018 22:17:25 -0500 Subject: [PATCH] MAINT: More wording fixes. Grammar and such. --- README.md | 23 ++++++++++++++++++++--- src/main.rs | 3 ++- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c1b4216..8afbd50 100644 --- a/README.md +++ b/README.md @@ -45,22 +45,39 @@ SUBCOMMANDS: validate Check a specific ucg file for errors. ``` -## compiling a file +## Compiling ```sh Build a list of ucg files. USAGE: - ucg build ... + ucg build [FLAGS] -r [INPUT]... FLAGS: -h, --help Prints help information + -r Whether we should recurse in directories or not. -V, --version Prints version information ARGS: - ... Input ucg files to build. + ... Input ucg files or directories to build. If not provided then build the contents of the current directory. ``` +## Validating + ```sh + Check a list of ucg files for errors and run assertions. + +USAGE: + ucg validate [FLAGS] -r [INPUT]... + +FLAGS: + -h, --help Prints help information + -r Whether we should recurse or not. + -V, --version Prints version information + +ARGS: + ... Input ucg files or directories to validate. If not provided scan the directory for files with _test.ucg + ``` + ## Language Reference https://docs.rs/ucg/ \ No newline at end of file diff --git a/src/main.rs b/src/main.rs index 9b103a1..877d050 100644 --- a/src/main.rs +++ b/src/main.rs @@ -50,7 +50,7 @@ fn do_flags<'a>() -> clap::ArgMatches<'a> { (@subcommand validate => (about: "Check a list of ucg files for errors and run assertions.") (@arg recurse: -r +required conflicts_with[INPUT] "Whether we should recurse or not.") - (@arg INPUT: ... "Input ucg files or directories to validate. If not provided scan the director for files with _test.ucg") + (@arg INPUT: ... "Input ucg files or directories to validate. If not provided it will scan the directories for files with _test.ucg") ) (@subcommand converters => (about: "list the available converters") @@ -272,5 +272,6 @@ fn main() { } process::exit(0); } else if let Some(_todo) = app.subcommand_matches("converters") { + // TODO(jwall): Flesh this command out. } }