Skip to content
GitLab
Menu
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
3a1866fc
Commit
3a1866fc
authored
Mar 16, 2018
by
Didier Verna
Browse files
Tighten up the README file.
parent
5a5cd024
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
3a1866fc
# Quickref
Quickref is a global documentation project for Common Lisp libraries. It
generates a website containing reference manuals for every
[
Quicklisp
](
https://www.quicklisp.org
)
library available. The reference
...
...
@@ -13,12 +12,10 @@ needed to generate your own version of the website.
## Using Quickref
In order to generate your local version of the website, you can use Quickref
either through the provided Docker images, or directly from the source.
### From Docker
This is the simplest way to use Quickref. The Docker image ships with a
complete build environment that aims to reproduce the one used to create the
Quicklisp releases. This means it contains (almost) all the dependencies
...
...
@@ -56,7 +53,6 @@ errors during processing (from both Declt and `makeinfo`).
### From the source
If you're feeling bold, you can also run Quickref directly from the source,
but beware that Quicklisp has a
*lot*
of external dependencies that will be
required for processing. Look at the file
`docker/debian-8-packages.txt`
to
...
...
@@ -77,10 +73,8 @@ HTML.
The generated files (logs, Texinfo, and HTML) can be found in
`~/quickref/`
.
#### Customization
The
`REFRESH`
function accepts a number of keyword options allowing you to
tweak the behavior of Quickref.
*
`: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.
...
...
@@ -93,7 +87,6 @@ tweak the behavior of Quickref.
## Docker images
You can build your own Quickref Docker images by using the provided
Dockerfiles located in the
`docker`
directory. The project is split in 2
separate images:
...
...
@@ -110,7 +103,6 @@ the hundreds of dependencies installed from `apt`).
### Building the images
The two Quickref Docker images are created by typing respectively (and in that
order):
```
...
...
@@ -119,7 +111,6 @@ docker build -t quickref .
```
### Extracting the website
With
`docker ps -a`
, get the name/ID of your image. The output should look
like this (with a different name/ID for you):
```
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a 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