Commit 0fcf9afb authored by Antoine Martin's avatar Antoine Martin
Browse files

Improve README

parent 95c79d70
# quickref
The `quickref` ASDF system currently provides helper functions used to bridge the gap between `declt` and `quicklisp`.
The `quickref` ASDF system currently provides helper functions used to bridge
the gap between `declt` and `quicklisp`.
To launch the generation of documentation for every quicklisp package, use the [qlmapper](https://github.com/xach/qlmapper) package with `test_declt.lisp`
To launch the generation of documentation for every quicklisp package, use the
[`qlmapper`](https://github.com/xach/qlmapper) package with `test_declt.lisp`:
To list packages where the installation or generation of documentation failed, execute the `list_untreated.sh` script in quicklisp's package directory (usually `~/quicklisp/dists/quicklisp/software`)
This will create a `missing_texi.txt` file with directories missing the texi documentation.
```lisp
(qlmapper:map-releases "repo-path/test_declt.lisp")
```
To list packages where the installation or generation of documentation failed,
execute the `list_untreated.sh` script in quicklisp's package directory
(usually `~/quicklisp/dists/quicklisp/software`)
This will create a `missing_texi.txt` file with directories missing the texi
documentation.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment