Commit fea461a7 authored by Antoine Martin's avatar Antoine Martin
Browse files

Don't call (use-package :quickref) in README

parent c94cbfe2
......@@ -12,8 +12,7 @@ From your lisp REPL, just do:
```lisp
(ql:quickload :quickref)
(use-package :quickref)
(refresh)
(quickref:refresh)
```
This will trigger a complete cycle, which includes downloading and installing
......@@ -49,10 +48,10 @@ docker cp my-container:/home/quickbuilder/quickref .
### Multithreading
Quickref supports multithreading; by calling `(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.
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
......@@ -61,7 +60,7 @@ By default, Quickref will use the `makeinfo` found in your path to generate the
`:makeinfo-path` keyword argument:
```lisp
(refresh :makeinfo-path "/usr/local/bin/makeinfo")
(quickref:refresh :makeinfo-path "/usr/local/bin/makeinfo")
```
### Logging
......@@ -72,7 +71,7 @@ Errors are logged by default, logs can be found in
To disable logging, you can use the `log-errors` keyword argument:
```lisp
(refresh :log-errors nil)
(quickref:refresh :log-errors nil)
```
## Docker images
......
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