Commit 380074a2 authored by Didier Verna's avatar Didier Verna
Browse files

Rework the customization part in README.md.

parent 93732ad4
......@@ -77,36 +77,21 @@ HTML.
The generated files (logs, Texinfo, and HTML) can be found in
`$HOME/quickref/`.
#### Customization
## Advanced usage
The `REFRESH` function accepts a number of keyword options allowing you to
tweak the behavior of Quickref.
### Multithreading
* `:parallel`: if true, Quickref will parallelize the generation of the
Texinfo and HTML files. This option is recommended if your machine has
multiple cores available.
* `:makeinfo-path`: a pathname to the location of the `makeinfo`
executable, other than what can be found in your `PATH` environment
variable.
* `:log-errors`: Quickref logs the output of both Declt and `makeinfo` by
default. If you turn logging of (by setting this option to `NIL`), Quickref
will instead stop processing if an error is encountered.
Quickref supports multithreading; by calling `(quickref:refresh :parallel t)`.
Quickref will launch both the generation of `.texi` files and the generation of
`.html` files at the same time. This option is recommended if your machine has
multiple cores available.
### Custom `makeinfo` path
By default, Quickref will use the `makeinfo` found in your `PATH` to generate
the `.texi` files, but you can provide a custom one by calling Quickref with
the `:makeinfo-path` keyword argument:
```lisp
(quickref:refresh :makeinfo-path "/usr/local/bin/makeinfo")
```
### Logging
Errors are logged by default, logs can be found in
`quickref/logs/{declt,makeinfo}/`.
To disable logging, you can use the `log-errors` keyword argument:
```lisp
(quickref:refresh :log-errors nil)
```
## Docker images
......
Supports Markdown
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