commit dff4eb5870bcda92bb5ac928ef765c2c62437b89 Spenser Truex <web@spensertruex.com> 2020-03-26 16:04:37 -0700 Add more usage documentation
README.md | 33 +++++++++++++++++++++++++++------ 1 file changed, 27 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md index 4794d72..faa60ee 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,30 @@ # Sigil -Generate source documentation inside of texinfo files with short macros. +Generate documentation for sigil lines in the source, according to some input +documentation standard. This is intended to be the first pass in processing some +documentation. + +This library is modified from that used to generate the docs for +[StumpWM](https://stumpwm.github.io/). + +## Usage +Each "sigil" is a three character string must be at the beginning of the line, +and followed by a Common Lisp symbol. Some projects may need to define their own +sigils using `defdoc`. + +Default included sigils: +```tex +@@@ function +%%% macro +### variable +``` + +### Texinfo +Currently the only supported output format is texinfo. +input: ``` tex +@c This is a texinfo comment. It will not be exported. @c defun is a macro defined in the standard. %%% defun ``` @@ -13,21 +35,20 @@ Which expands to: Define a function at top level. @end defmac ``` -This has been used to generate the docs for [StumpWM](https://stumpwm.github.io/). - ## Install Requires SBCL, because `sb-introspect` is used. Support for other implementations is welcome. ## Hacking -Write new forms with the `defdoc` macro. +Write new sigils with the `defdoc` macro. ### TODO - - Be more general in supporting more output types than tex. +- Do not require sb-introspect, use other methods or leave out certain data as + needed. ## License -GNU GPL 2.0 +GNU GPL v3 ### _Spenser Truex <web@spensertruex.com>_