[circle-verify] Readme (#8635)
author박세희/On-Device Lab(SR)/Principal Engineer/삼성전자 <saehie.park@samsung.com>
Thu, 31 Oct 2019 01:56:01 +0000 (10:56 +0900)
committerGitHub Enterprise <noreply-CODE@samsung.com>
Thu, 31 Oct 2019 01:56:01 +0000 (10:56 +0900)
* [circle-verify] Readme

This will introduce circle-verify readme file explaining it's usage

Signed-off-by: SaeHie Park <saehie.park@samsung.com>
* edit about

* change output format

compiler/circle-verify/README.md [new file with mode: 0644]

diff --git a/compiler/circle-verify/README.md b/compiler/circle-verify/README.md
new file mode 100644 (file)
index 0000000..1eda8a9
--- /dev/null
@@ -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
+```