From 15f68c47b7ddc762919a17a6bd86f5d45be814a2 Mon Sep 17 00:00:00 2001 From: Jaidyn Ann <10477760+JadedCtrl@users.noreply.github.com> Date: Mon, 27 May 2024 22:49:39 -0500 Subject: [PATCH] Update README Tweaking line-breaks, and mentioning the tests. --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fb9d118..0bab719 100644 --- a/README.md +++ b/README.md @@ -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,12 @@ $ sudo cp eksd /usr/local/bin/eksd Bam, you've made and installed a binary! Cool! +### Tests +eksd’s tests can be run using the `test` Makefile target, or simply +`(asdf:test-system :eksd)` and `(asdf:test-system :eksd-unix)`. + +`$ make test` + ## Misc * License is the GNU GPLv3 ([COPYING.txt](COPYING.txt))