Update doc
This commit is contained in:
parent
2245ceb29f
commit
59aa2d5f9a
1 changed files with 17 additions and 1 deletions
18
docs.lisp
18
docs.lisp
|
@ -41,6 +41,7 @@ and [Qlot](https://github.com/fukamachi/qlot) inside the Github CI.
|
||||||
"
|
"
|
||||||
(@features section)
|
(@features section)
|
||||||
(@typical-usage section)
|
(@typical-usage section)
|
||||||
|
(@roswell-version section)
|
||||||
(@asdf-version section)
|
(@asdf-version section)
|
||||||
(@ql-file section)
|
(@ql-file section)
|
||||||
(@caching section)
|
(@caching section)
|
||||||
|
@ -54,7 +55,7 @@ and [Qlot](https://github.com/fukamachi/qlot) inside the Github CI.
|
||||||
(defsection @features (:title "What this action does for you?")
|
(defsection @features (:title "What this action does for you?")
|
||||||
"
|
"
|
||||||
* It installs Roswell and all it's dependencies, doing right thing depending on
|
* It installs Roswell and all it's dependencies, doing right thing depending on
|
||||||
the operating system. It should work on Ubuntu, OSX and maybe Windows.
|
the operating system. It should work on Ubuntu, OSX and Windows.
|
||||||
* Upgrade ASDF to the latest version.
|
* Upgrade ASDF to the latest version.
|
||||||
* Installs Qlot.
|
* Installs Qlot.
|
||||||
* Adds to `PATH` these directories: `~/.roswell/bin` and `.qlot/bin`
|
* Adds to `PATH` these directories: `~/.roswell/bin` and `.qlot/bin`
|
||||||
|
@ -127,6 +128,20 @@ system. It is documented [here](https://40ants.com/run-tests).
|
||||||
")
|
")
|
||||||
|
|
||||||
|
|
||||||
|
(defsection @roswell-version (:title "Overriding Roswell version")
|
||||||
|
"
|
||||||
|
By default this action will install the latest version of Roswell. However,
|
||||||
|
should you need to use a different version instead, you can specify that via
|
||||||
|
the `roswell-version` argument:
|
||||||
|
|
||||||
|
```
|
||||||
|
- uses: 40ants/setup-lisp@v1
|
||||||
|
with:
|
||||||
|
roswell-version: v21.06.14.110
|
||||||
|
```
|
||||||
|
")
|
||||||
|
|
||||||
|
|
||||||
(defsection @asdf-version (:title "Overriding qlfile")
|
(defsection @asdf-version (:title "Overriding qlfile")
|
||||||
"
|
"
|
||||||
By default, action will install the latest ASDF version. But sometimes you might
|
By default, action will install the latest ASDF version. But sometimes you might
|
||||||
|
@ -150,6 +165,7 @@ matrix:
|
||||||
os:
|
os:
|
||||||
- ubuntu-latest
|
- ubuntu-latest
|
||||||
- macos-latest
|
- macos-latest
|
||||||
|
- windows-latest
|
||||||
quicklisp-dist:
|
quicklisp-dist:
|
||||||
- quicklisp
|
- quicklisp
|
||||||
- ultralisp
|
- ultralisp
|
||||||
|
|
Loading…
Reference in a new issue