diff options
Diffstat (limited to 'compiler/circle-verify/README.md')
| -rw-r--r-- | compiler/circle-verify/README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/compiler/circle-verify/README.md b/compiler/circle-verify/README.md new file mode 100644 index 000000000..1eda8a99e --- /dev/null +++ b/compiler/circle-verify/README.md @@ -0,0 +1,23 @@ +# circle-verify + +_circle-verify_ allows users to verify Circle models. + +## Usage + +Provide _circle_ file as a parameter to verify validity. + +``` +$ circle-verify circlefile.circle +``` + +Result for valid file +``` +[ RUN ] Check circlefile.circle +[ PASS ] Check circlefile.circle +``` + +Result for invalid file +``` +[ RUN ] Check circlefile.circle +[ FAIL ] Check circlefile.circle +``` |