jadedctrl/eksd
jadedctrl/ eksd
1
0
Disbranĉigi 0
Fontkodo Issues Tirpetoj Eldonoj Activity

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 58aedf06c0
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -54,9 +54,12 @@ $ xxd castlevania.nes | grep -A4 "18e80"
## 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. It’s 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. It’s 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:
@ -68,6 +71,19 @@ $ sudo cp eksd /usr/local/bin/eksd
Bam, you've made and installed a binary! Cool!
### Tests
eksd’s tests can be run from a REPL using `ASDF:TEST-SYSTEM`, or from the
Makefile target “test”.
```
* (asdf:test-system :eksd)
* (asdf:test-system :eksd/unix)
```
```
`$ make test
```
## Misc
* License is the GNU GPLv3 ([COPYING.txt](COPYING.txt))