Give some introduction.
Explain why this project so outstanding and why it was created.
You can give some examples. This is how common lisp code should be formatted:
(defvar log-item '(:|@message| "Some" :|@timestamp| 122434342 ;; this field is wrong and ;; shouldn't be here :|@fields| nil))
And this is how you can provide REPL examples:
TEST> (format nil "Blah minor: ~a" 100500) "Blah minor: 100500"
Provide a Roadmap.
Provide instruction how to build or use your library.
How to build documentation
To build documentation, you need a Sphinx. It is documentaion building tool written in Python.
To install it, you need a virtualenv. Read this instructions how to install it.
Also, you'll need a cl-launch. It is used by documentation tool to run a script which extracts documentation strings from lisp systems.
Run these commands to build documentation:
virtualenv env source env/bin/activate pip install -r docs/requirements.txt invoke build_docs
These commands will create a virtual environment and
install some python libraries there. Command
will build documentation and upload it to the GitHub, by replacing
the content of the
- Alexander Artemenko
Copyright (c) 2017 Alexander Artemenko
Licensed under the BSD License.