qlot docs improved

This commit is contained in:
David Botton 2024-07-07 16:45:20 -04:00
parent ea0d495c5a
commit e3585b264c
2 changed files with 24 additions and 9 deletions

32
QLOT.md vendored
View file

@ -1,21 +1,21 @@
Using QLOT with CLOG Builder
QLOT creates a local quicklisp for your project. The following instructions
will show you how to take a CLOG project (or and Common Lisp project) and
convert it for use woth qlot.
will show you how to take a CLOG project (or any Common Lisp project) and
convert it for use with qlot.
https://github.com/fukamachi/qlot
NOTE - qlot does not seem to work with window
After have created a CLOG project, copy it to its own porjects DIR do not use
~/common-lisp
NOTE - qlot does not appear to work with Windows
After you have created a CLOG project, copy it to its own projects directory,
do not use ~/common-lisp or other project directory already in use by your
global quicklisp install.
for this example I created ~/projects and then move my CLOG project qtest to
~/projects/qtest
So cd to ~/projects/qtest
cd ~/projects/qtest
Create a file call qlfile with:
@ -23,6 +23,9 @@ Create a file call qlfile with:
dist http://dist.ultralisp.org/
```
(I am using the REPL method for maximum compatability, if you alredy know
qlot you can use the command line tool if you have installed it.)
run sbcl and type:
```
@ -32,7 +35,7 @@ run sbcl and type:
(qlot:install)
```
To work on your project using your qlot quicklisp cd to your dir (example
To work on your project using your qlot quicklisp, cd to your dir (example
~/projects/qtest ) and run
sbcl with:
@ -43,10 +46,21 @@ sbcl with:
(pushnew (uiop:getcwd) ql:*local-project-directories* :test #'equalp)
```
You are now in your private qlot world for your project so to run the CLOG
You are now in your private qlot world for your project, so to run the CLOG
builder do:
```
(ql:quickload :qtest/tools)
(clog-tools:clog-builder :project :qtest)
```
To make things easier create a file say - ql and chmod 775
```
sbcl --eval "(ql:quickload :qlot)" \
--eval "(setf qlot:*project-root* (uiop:getcwd))" \
--eval "(qlot:init (uiop:getcwd))" \
--eval "(pushnew (uiop:getcwd) ql:*local-project-directories* :test #'equalp)" \
--eval "(ql:quickload :qtest/tools)" \
--eval "(clog-tools:clog-builder :project :qtest)"
```

1
qlfile vendored Normal file
View file

@ -0,0 +1 @@
dist http://dist.ultralisp.org/