mirror of
https://github.com/zaphar/ucg.git
synced 2025-07-22 18:19:54 -04:00
Add usage documentation to the readme.
This commit is contained in:
parent
50d31cb5ef
commit
f105d93c14
24
README.md
24
README.md
@ -14,7 +14,29 @@ be version controlled, enforce _some_ typesafety, and output
|
||||
configuration for any application regardless of that applications
|
||||
preferred format.
|
||||
|
||||
## Examples
|
||||
## Usage
|
||||
|
||||
You can get ucg with cargo `cargo install ucg`.
|
||||
|
||||
Running ucg help will show the following output.
|
||||
|
||||
```sh
|
||||
Universal Configuration Grammar compiler.
|
||||
|
||||
USAGE:
|
||||
ucg [SUBCOMMAND]
|
||||
|
||||
FLAGS:
|
||||
-h, --help Prints help information
|
||||
-V, --version Prints version information
|
||||
|
||||
SUBCOMMANDS:
|
||||
build Compile a specific ucg file.
|
||||
help Prints this message or the help of the given subcommand(s)
|
||||
validate Check a specific ucg file for errors.
|
||||
```
|
||||
|
||||
## Language Examples
|
||||
|
||||
#### Base Types
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user