Update README

Tweaking line-breaks, and mentioning the tests.
This commit is contained in:
Jaidyn Ann 2024-05-27 22:49:39 -05:00
parent 172a10fdc5
commit 15f68c47b7

View File

@ -54,9 +54,12 @@ $ xxd castlevania.nes | grep -A4 "18e80"
## Installation ## Installation
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`. 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). 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: To install Quicklisp, build a binary, and install it, simply:
@ -68,6 +71,12 @@ $ sudo cp eksd /usr/local/bin/eksd
Bam, you've made and installed a binary! Cool! Bam, you've made and installed a binary! Cool!
### Tests
eksds tests can be run using the `test` Makefile target, or simply
`(asdf:test-system :eksd)` and `(asdf:test-system :eksd-unix)`.
`$ make test`
## Misc ## Misc
* License is the GNU GPLv3 ([COPYING.txt](COPYING.txt)) * License is the GNU GPLv3 ([COPYING.txt](COPYING.txt))