Update README, to detail the Makefile

This commit is contained in:
Jaidyn Ann 2024-05-26 23:46:16 -05:00
parent 91c85c4ba4
commit 084d948e43

View File

@ -54,17 +54,19 @@ $ xxd castlevania.nes | grep -A4 "18e80"
## Installation
Making a binary requires a Lisp (I recommend SBCL) and Quicklisp
(https://quicklisp.org).
Making a binary requires [an implementation](https://common-lisp.net/implementations) of Common Lisp installed: [Steel Bank Common Lisp](https://sbcl.org/) is our implementation-of-choice. Its available on most operating systems under the package name `sbcl`.
You also need the library-manager [Quicklisp](https://quicklisp.org), which can [be installed](https://www.quicklisp.org/beta/#installation) quite easily, including via our [Makefile](Makefile).
To install quicklisp, build a binary, and install it, simply:
Put this repository into your `quicklisp/local-projects/`, then run, in your
lisp interpreter:
```
# (ql:quickload '(eksd eksd.unix))
# (save-lisp-and-die "eksd" :toplevel #'eksd.unix:main :executable t)
$ make quicklisp
$ make build
$ sudo cp eksd /usr/local/bin/eksd
```
And bam, you've made a binary. Cool.
Bam, you've made and installed a binary! Cool!
## Misc