The README appears to be out of date, and directs the new user to a doc string that doesn't seem to exist

[dfmorrison]

The README says

The documentation can be found in the docstrings, start with the package :it.bese.fiveam (nicknamed 5AM).

But that package appears not to have a docstring:

CL-USER> (find-package :it.bese.fiveam)
#<PACKAGE "IT.BESE.FIVEAM">
CL-USER> (documentation * t)
NIL
CL-USER>

and

dfm@helmsley:/tmp/fiveam$ cat version.sexp
;; -*- lisp -*-
"1.4.2"
dfm@helmsley:/tmp/fiveam$ grep ':documentation' src/package.lisp
dfm@helmsley:/tmp/fiveam$

Google turns up documentation at

https://common-lisp.net/project/fiveam/docs/index.html

but it seems out of date. For example, it says

Variable DEBUG-ON-ERROR T if we should drop into a debugger on error, NIL otherwise.

Variable DEBUG-ON-FAILURE T if we should drop into a debugger on a failing check, NIL otherwise.

but looking at the source it appears that both these variables are now deprecated. Is there current documentation, suitable for a new user, available somewhere?

Thanks!

[L0ren2]

I would like to see a detailed installation introduction in the README

[sionescu]

@dfmorrison I can't build the documentation because the documentation system has been abandoned. I don't have a solution for the moment, other than reading the sources of Fiveam or those of libraries that use it. @L0ren2 What instructions do you need in addition to using Quicklisp ?

[L0ren2]

@L0ren2 What instructions do you need in addition to using Quicklisp ?

Honestly, I have no idea. When I tried last time, everything I downloaded using quicklisp was broken out of the box. Probably a mistake on my end but it kept me from following through with it. I actually don't use Lisp anymore since I just needed to know some of it for my university assignments. Now thats done, I do consider dipping my toes into learning Clojure, however I don't think that I will be touching Clisp anytime soon.