Add coverage, get to near 100

[sheep] / README.md

diff --git a/README.md b/README.md
index 039c15d3285d15767fb74b5caef86debe83000f7..7a585a277045c06a809beb8d9bf3bae7423e9662 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,11 +4,11 @@ Enforcement of documentation guidelines for my Common Lisp Projects, as well as
 
 I wish I had aspirations for this being some standard that someone else might follow, but realistically I'm just irritated at my own laziness with regard to documentation, so I wrote a solution.  The forceful nature of the validator is really just because I didn't want to write a smarter parser.  As an added bonus, all the docs now look the same when I look at them in the repl, so that's kind of nice.
 
-If you like, you can [download it](https://github.com/frankduncan/docgen/releases/download/0.1/docgen_0.1.tar.gz)
+If you like, you can [download it](https://consxy.com/sheep/releases/0.3/docgen_0.3.tar.gz)
 
 ## Usage
 
-See the [wiki](https://github.com/frankduncan/docgen/wiki) for usage information (generated by this package).
+See [Reference](https://consxy.com/sheep/reference.html) for usage information (generated by this package).
 
 To see how that page was created, take a look at bin/generatedocs.sh
 
@@ -18,13 +18,42 @@ Packages are documented by sections broken up by one empty line, with the first
 
 ## Structure/Condition documentation
 
-Requirements are the same as the package
+Requirements are the same as the package documentation.
+
+## Variable documentation
+
+Variables should follow the template:
+
+```
+*VARIABLE*
+
+VALUE TYPE:
+
+  a generalized boolean
+
+INITIAL VALUE:
+
+  NIL
+
+DESCRIPTION:
+
+  *VARIABLE* is expected to be a boolean, but
+  most anything can be it.
+
+EXAMPLES:
+
+  (let ((*variable* t)) (go)) => let-it-go
+```
+
+There are three required sections and one optional section.  ```VALUE TYPE```, ```INITIAL VALUE```, and ```DESCRIPTION``` are freeform, with the ```EXAMPLES``` section following the same rules as below in the function documentation.
+
+### 
 
 ## Function documentation
 
 Functions should follow the template:
 
-````
+```
 FUNC PATH => RESULT
 
   RESULT: SUCCESS-RESULTS | FAILURE-RESULT
@@ -47,7 +76,7 @@ EXAMPLES:
 
   (func #P\"path/to/file.lisp\" t) => (:success \"path/to/file.lisp\")
   (func #P\"path/to/error.lisp\" nil) => (:failure \"path/to/error.lisp\" \"Error msg\")
-````
+```
 
 There are four sections to each function definition: