From 290b6a9de3f2877dca7f6e623fae435b373d24ef Mon Sep 17 00:00:00 2001 From: Darren Bane Date: Thu, 22 Oct 2020 18:51:01 +0100 Subject: More hyperlinks --- doc/Makefile | 2 +- doc/breaking_rules.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) (limited to 'doc') diff --git a/doc/Makefile b/doc/Makefile index 7e21ba4..d481321 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -27,7 +27,7 @@ lkbib.txt: macros.ms lkbib.ms refs.i groff -Tutf8 -R -ms -k -Kutf8 macros.ms lkbib.ms > $@ %.gmi: %.md - md2gemini $^ > $@ + md2gemini -m $^ > $@ refs.i: refs indxbib $^ diff --git a/doc/breaking_rules.md b/doc/breaking_rules.md index 9b69e38..29c8267 100644 --- a/doc/breaking_rules.md +++ b/doc/breaking_rules.md @@ -62,7 +62,7 @@ Reasons for choosing Common Lisp include: * Contrary to a lot of other languages, it is fairly paradigm-agnostic. At the same time, I want a clean subset of CL, -so cleave as close to ISLisp as practical[5]. +so cleave as [close to ISLisp](bane.20.cdr15.md) as practical[5]. It was decided to use the imperative/object-oriented paradigm, partly for familiarity in industry and @@ -88,8 +88,8 @@ Even though this is a prototype, attention should be paid to basic craftsmanship * Use `declare` to check the types of parameters in public interfaces. * Indent all the source code using Emacs. -* Some minimal documentation, at least an overview README file[6] -and man (actually, mdoc) pages[7]. +* Some minimal documentation, at least an overview [README](https://tom.preston-werner.com/2010/08/23/readme-driven-development.html) file[6] + 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. If there is no standard protocol, I recommend using JSON-RPC as a base and following the documentation style of LSP. @@ -180,7 +180,7 @@ However, some of this documentation is better in the source code: * The summary of functions should be taken care of by having the public functions and classes commented. * The formal requirement for function behaviour can be done with - tables with Basic English[8]. + tables with [Basic English](https://en.wikipedia.org/wiki/Basic_English)[8]. * Although full design-by-contract may be out of reach a poor-man's version can be used with public functions following a pattern. This can also do some of the formal requirements. @@ -246,6 +246,6 @@ It is hoped that this is more effective than most of what is currently-used. [3]Kent Pitman, Accelerating Hindsight: Lisp as a Vehicle for Rapid Prototyping (1994). [4]Darren Bane, Design and Documentation of the Kernel of a Set of Tools for Working With Tabular Mathematical Expressions, University of Limerick, Ireland (19 Jul 2008). [5]Darren Bane, An ISLisp-like subset of ANSI Common Lisp, Ireland (21 Aug 2020). -[6]Tom Preston-Werner, Readme Driven Development, San Francisco, CA, USA (23 Aug 2010). available: https://tom.preston-werner.com/2010/08/23/readme- driven-development.html [accessed 27 May 2020]. +[6]Tom Preston-Werner, Readme Driven Development, San Francisco, CA, USA (23 Aug 2010). available: https://tom.preston-werner.com/2010/08/23/readme-driven-development.html [accessed 27 May 2020]. [7]Kristaps Dzonsons, Practical UNIX Manuals. available: https://manpages.bsd.lv/toc.html [accessed 9 Oct 2020]. [8]"Basic English" in Wikipedia. available: https://en.wikipedia.org/wiki/Basic_English [accessed 28 May 2020]. -- cgit 1.4.1-2-gfad0 3' href='#n3'>3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257