Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

modified: documentation.lisp #123

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions docs/documentation.lisp
Original file line number Diff line number Diff line change
Expand Up @@ -245,15 +245,21 @@ conjectures about GEB")

1. [lisp with quicklisp](https://lisp-lang.org/learn/getting-started/).

2. [Emacs](https://en.wikipedia.org/wiki/Emacs) along with one of the following:
2. a) [Emacs](https://en.wikipedia.org/wiki/Emacs) along with one of the following:

- [sly](https://github.com/joaotavora/sly)

+ [sly user manual](http://joaotavora.github.io/sly/)

- [slime](https://github.com/slime/slime)

+ [slime user manual](http://www.chiark.greenend.org.uk/doc/slime/slime.pdf)")
+ [slime user manual](http://www.chiark.greenend.org.uk/doc/slime/slime.pdf)

2. b) [Spacemacs](https://github.com/syl20bnr/spacemacs) along with:

- [slime](https://github.com/slime/slime) via
[the common-lisplayer](https://www.spacemacs.org/layers/+lang/common-lisp/README.html)
based on [sblc](https://www.sbcl.org/)")

(pax:defsection @loading (:title "loading")
"Now that we have an environment setup, we can load the project, this
Expand All @@ -270,10 +276,14 @@ conjectures about GEB")
- For Emacs, this is simply calling either `M-x sly` or `M-x slime`
if you are using either [sly](https://github.com/joaotavora/sly) or [slime](https://github.com/slime/slime)

- For Spacemacs, this is (also) `M-x slime` besides alternative key bindings

2. From Emacs: open `geb.asd` and press `C-ck` (`sly-compile-and-load-file`, or
`swank-compile-and-load-file` if you are using swank).

3. From Spacemacs: open `geb.asd` and press `C-c C-k` (invoking
`slime-compile-and-load-file`).

Now that we have the file open, we can now load the system by
writing:

Expand All @@ -291,7 +301,6 @@ writing:
(geb-test:run-tests)
```")


(pax:defsection @idioms (:title "Project Idioms and Conventions")
"The Geb Project is written in [Common
Lisp](https://common-lisp.net/), which means the authors have a great
Expand Down