mirror of
https://github.com/zaphar/ucg.git
synced 2025-07-22 18:19:54 -04:00
MAINT: More wording fixes. Grammar and such.
This commit is contained in:
parent
cb31ec8e31
commit
afa2cfb546
23
README.md
23
README.md
@ -45,22 +45,39 @@ SUBCOMMANDS:
|
|||||||
validate Check a specific ucg file for errors.
|
validate Check a specific ucg file for errors.
|
||||||
```
|
```
|
||||||
|
|
||||||
## compiling a file
|
## Compiling
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
Build a list of ucg files.
|
Build a list of ucg files.
|
||||||
|
|
||||||
USAGE:
|
USAGE:
|
||||||
ucg build <INPUT>...
|
ucg build [FLAGS] -r [INPUT]...
|
||||||
|
|
||||||
FLAGS:
|
FLAGS:
|
||||||
-h, --help Prints help information
|
-h, --help Prints help information
|
||||||
|
-r Whether we should recurse in directories or not.
|
||||||
-V, --version Prints version information
|
-V, --version Prints version information
|
||||||
|
|
||||||
ARGS:
|
ARGS:
|
||||||
<INPUT>... Input ucg files to build.
|
<INPUT>... 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>... Input ucg files or directories to validate. If not provided scan the directory for files with _test.ucg
|
||||||
|
```
|
||||||
|
|
||||||
## Language Reference
|
## Language Reference
|
||||||
|
|
||||||
https://docs.rs/ucg/
|
https://docs.rs/ucg/
|
@ -50,7 +50,7 @@ fn do_flags<'a>() -> clap::ArgMatches<'a> {
|
|||||||
(@subcommand validate =>
|
(@subcommand validate =>
|
||||||
(about: "Check a list of ucg files for errors and run assertions.")
|
(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 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 =>
|
(@subcommand converters =>
|
||||||
(about: "list the available converters")
|
(about: "list the available converters")
|
||||||
@ -272,5 +272,6 @@ fn main() {
|
|||||||
}
|
}
|
||||||
process::exit(0);
|
process::exit(0);
|
||||||
} else if let Some(_todo) = app.subcommand_matches("converters") {
|
} else if let Some(_todo) = app.subcommand_matches("converters") {
|
||||||
|
// TODO(jwall): Flesh this command out.
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user