Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Antoine Martin
quickref
Commits
df402dcf
Commit
df402dcf
authored
Nov 30, 2017
by
Antoine Martin
Browse files
Add more documentation to README.md
parent
71643bf1
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
df402dcf
...
...
@@ -8,24 +8,27 @@ The reference manuals are generated by
## Using `quickref`:
From
the
lisp REPL, just do:
From
your
lisp REPL, just do:
```
lisp
(
ql:quickload
"quickref"
)
(
quickref:refresh
)
(
ql:quickload
:quickref
)
(
use-package
: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 Quicklisp packages, generating the .texi files for all of them thanks to
Declt,
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.
aims to reproduce the one used to create the Quicklisp releases. This means it
contains (almost) all the dependencies needed to build every library available
on Quicklisp.
To run quickref from the image just do:
...
...
@@ -40,4 +43,34 @@ You can then get the produced files with
```
docker cp my-container:/home/quickbuilder/quickref .
```
\ No newline at end of file
```
## Advanced usage
### 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.
### Custom `makeinfo` path
By default, Quickref will use
`/usr/local/bin/makeinfo`
to generate the
`.texi`
files, but you can provide a custom one by calling Quickref with the
`:makeinfo-path`
keyword argument:
```
lisp
(
refresh
:makeinfo-path
"/usr/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
(
refresh
:log-errors
nil
)
```
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment