Update README
Tweaking line-breaks, and mentioning the tests.
This commit is contained in:
parent
172a10fdc5
commit
58aedf06c0
20
README.md
20
README.md
|
@ -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. 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:
|
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!
|
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
|
## Misc
|
||||||
* License is the GNU GPLv3 ([COPYING.txt](COPYING.txt))
|
* License is the GNU GPLv3 ([COPYING.txt](COPYING.txt))
|
||||||
|
|
Ŝarĝante…
Reference in New Issue