aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDarren Bane <darren.bane@gmail.com>2020-12-10 00:30:32 +0000
committerDarren Bane <darren.bane@gmail.com>2020-12-10 00:30:32 +0000
commitf16f553f2effb7ac8120fb8a15b59bcdd480a97d (patch)
tree935e3d5eb17df4236a1d3ad2cc8abf21b40f9632
parent930adcd596cf28b41ee26c8ffdc98640dfc9b4bd (diff)
downloadlsp-f16f553f2effb7ac8120fb8a15b59bcdd480a97d.tar.gz
Nicer gemini output
-rw-r--r--doc/Makefile5
-rw-r--r--doc/breaking_rules.md10
2 files changed, 8 insertions, 7 deletions
diff --git a/doc/Makefile b/doc/Makefile
index 6e549c5..8716885 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -6,7 +6,8 @@
GEMINI := breaking_rules.gmi bane.20.cdr15.gmi
.PHONY: all
-all: $(GEMINI) lkbib.txt
+all: $(GEMINI)
+# lkbib.txt can be made manually as needed
# Write gfm.
# Beyond that, YAGNI.
@@ -18,7 +19,7 @@ lkbib.txt: macros.ms lkbib.ms refs.i
groff -Tutf8 -R -ms -k -Kutf8 macros.ms lkbib.ms > $@
%.gmi: %.md
- md2gemini -m $^ > $@
+ md2gemini -m -l copy $^ > $@
refs.i: refs
indxbib $^
diff --git a/doc/breaking_rules.md b/doc/breaking_rules.md
index 7cfc99c..0c34594 100644
--- a/doc/breaking_rules.md
+++ b/doc/breaking_rules.md
@@ -55,8 +55,8 @@ without earning money.
## Design Decisions
The programming language chosen is a particular style of Common Lisp.
-A clean subset of CL is desired,
-so cleave as [close to ISLisp](bane.20.cdr15.md) as practical[5].
+For readability my
+[ISLisp-like subset of CL](bane.20.cdr15.md) should be followed where practical[5].
Reasons for this decision include:
* Contrary to a lot of other languages, Lisp is fairly paradigm-agnostic.
@@ -92,7 +92,7 @@ Even though this is a prototype, attention should be paid to basic craftsmanship
* Use `declare`
to check the types of parameters in public interfaces (see below).
* Indent all the source code using Emacs.
-* Some minimal documentation, at least an overview [README](https://tom.preston-werner.com/2010/08/23/readme-driven-development.html) file
+* Some minimal documentation, at least an overview like in [README driven development](https://tom.preston-werner.com/2010/08/23/readme-driven-development.html)
and man (actually, [mdoc](https://manpages.bsd.lv/toc.html)) pages[7].
* Certain parts of a system justify greater detail for a *complete* specification.
These are (newly-designed) network protocols and complex persistent data models.
@@ -204,8 +204,8 @@ For productisation you may want to add more features.
Although the official ANSI standard is moribund,
quasi-standard libaries are recommended on the
-[awesome list](https://github.com/CodyReichert/awesome-cl),
-or [portability layers](http://portability.cl/).
+[Awesome-CL list](https://github.com/CodyReichert/awesome-cl),
+or [CL portability layers](http://portability.cl/).
Usage should be limited as follows,
in order of preference.
The language/library split isn't as clear in CL as in some other languages,