Commit 53ee8aed authored by Antoine Martin's avatar Antoine Martin
Browse files

Update README.md with current project instructions

parent 21867627
# quickref
The `quickref` ASDF system currently provides helper functions used to bridge
the gap between `declt` and `quicklisp`.
Quickref generates a website with reference manuals for every
[Quicklisp](https://www.quicklisp.org) library available.
To launch the generation of documentation for every quicklisp package, use the
[`qlmapper`](https://github.com/xach/qlmapper) package with `test_declt.lisp`:
The reference manuals are generated by
[Declt](https://github.com/didierverna/declt).
## Using `quickref`:
From the lisp REPL, just do:
```lisp
(qlmapper:map-releases "repo-path/test_declt.lisp")
(ql:quickload "quickref")
(quickref:refresh)
```
This will trigger a complete cycle, which includes downloading and installing
the Quicklisp packages, generating the .texi files for all of them thanks to,
and generating the final website structure by converting the .texi files to
HTML.
The generated files can by default be found in `$HOME/quickref/`.
## Docker image:
A Docker image is available, it ships with a complete build environment that
aims to reproduce the one used to create the Quicklisp releases.
To run quickref from the image just do:
```
docker pull quickref/quickref
docker run quickref/quickref
```
This will run `(quickref:refresh)` in the image.
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.
You can then get the produced files with
```
docker cp my-container:/home/quickbuilder/quickref .
```
\ No newline at end of file
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