From b1728e4f94058790d3a03e5fdc9bc1d1464aed39 Mon Sep 17 00:00:00 2001 From: Carl Gay Date: Thu, 25 Apr 2024 20:25:38 -0400 Subject: [PATCH 1/6] CONTRIBUTING.md: fix markdown, remove EOL whitespace There was an unterminated `**` bold markup. --- CONTRIBUTING.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6ab2030d..8c50e15e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,17 +2,17 @@ 1. If filing a new article, please check the bug tracker and, if the issue is not already there, please file a bug before - doing the work. There is likely to be discussion which could + doing the work. There is likely to be discussion which could help. Why waste your own time? - -2. Please contribute in English (poor English is **OK**, the - maintainers can help and it'll **be improved!). Please verify - all Lisp code works, noting the specific Lisp implementation + +2. Please contribute in English (poor English is **OK**, the + maintainers can help and it'll **be improved!**). Please verify + all Lisp code works, noting the specific Lisp implementation you used to verify. Please verify all links work. - + 3. Please check the license. Your work may be edited, copied, and changed, and you should be OK with that! And, please do not copy and paste code you - don't have the copyright to! - -4. Please don't be afraid to file a bug as the method of communication. It's + don't have the copyright to! + +4. Please don't be afraid to file a bug as the method of communication. It's much easier to find for others when you do that. From 5f4fdbafbff22badb6571a61c98e8079a00decf6 Mon Sep 17 00:00:00 2001 From: Carl Gay Date: Mon, 29 Apr 2024 12:45:07 -0400 Subject: [PATCH 2/6] README.md: minor grammar and markdown fixes --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7b0aeed1..5fd7bc5a 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Then open `http://127.0.0.1:4000/cl-cookbook/` (the last `/` is important). ### Install system locally using Ruby gems -Another option is to install the Jekyll version of this repository locally with Ruby gems. Since bundler 1.17.3 requires Ruby 2.5 that is rather old, it is recommended to install it using rbenv: +Another option is to install the Jekyll version of this repository locally with Ruby gems. Since bundler 1.17.3 requires Ruby 2.5 that is rather old, it is recommended to install it using `rbenv`: 1. Install [rbenv](https://github.com/rbenv/rbenv) using your package manager, or follow [these instructions](https://github.com/rbenv/rbenv#basic-github-checkout) to install it manually. 2. Install [ruby-build](https://github.com/rbenv/ruby-build#installation). If you did a manual installation in the previous step, it is recommended to install ruby-build as a rbenv plugin. @@ -76,7 +76,7 @@ Run `make epub`. See `make-cookbook.lisp`. You need a decently recent version of [Calibre](https://calibre-ebook.com/). They provide an easy binary installation. -To exclude regions of text of the build (for example, embedded videos that makes no sense in a print format), use these flags: +To exclude regions of text from the output (for example, embedded videos that makes no sense in a print format), use these flags: From 3ab311b9f82df0971688c7471e5586d7b6728072 Mon Sep 17 00:00:00 2001 From: Carl Gay Date: Mon, 29 Apr 2024 12:46:18 -0400 Subject: [PATCH 3/6] STYLEGUIDE.md: minor grammar fix --- STYLEGUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/STYLEGUIDE.md b/STYLEGUIDE.md index 0f564fd3..3a144d27 100644 --- a/STYLEGUIDE.md +++ b/STYLEGUIDE.md @@ -47,7 +47,7 @@ This snippet... If the result is large, use another code block, without comments. -- lines should not exceed 64 characters, otherwise the PDF will truncate them and show an horizontal scrollbar. +- lines should not exceed 64 characters, otherwise the PDF will truncate them and show a horizontal scrollbar. ## EPUB gotchas From 11facb0c357292011f6de73a26f1cc1550d6b2c1 Mon Sep 17 00:00:00 2001 From: Carl Gay Date: Mon, 29 Apr 2024 12:48:46 -0400 Subject: [PATCH 4/6] fix-epub-links.sed: minor grammar and spelling fixes --- fix-epub-links.sed | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/fix-epub-links.sed b/fix-epub-links.sed index ea620a33..01fe50e8 100644 --- a/fix-epub-links.sed +++ b/fix-epub-links.sed @@ -1,4 +1,4 @@ -# sed script to change internal links in markdown file, +# sed script to change internal links in markdown file # to links pandoc can use when generating EPUB from markdown. # Currently, the transformed links do not work in the web server, # so the script should change a file that is not used in the web server. @@ -10,7 +10,7 @@ # "[strings](strings.html)" to "[strings](#strings)" # pandoc associates each section header with a unique key, here "strings". # We specify the target header represented by "key", using the syntax (#key). -# This has to be used when the taget syntax [section header] is ambiguous. +# This has to be used when the target syntax [section header] is ambiguous. # Usage: # sed -i -f fix-epub-links.sed full.md # Note: From 9bf0da11254690dcc1f1714a0aa5e9a48370e39c Mon Sep 17 00:00:00 2001 From: Carl Gay Date: Mon, 29 Apr 2024 12:49:37 -0400 Subject: [PATCH 5/6] getting-started.md: grammar, rewording, remove dead link --- getting-started.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/getting-started.md b/getting-started.md index f71891e8..99d02d38 100644 --- a/getting-started.md +++ b/getting-started.md @@ -2,9 +2,9 @@ title: Getting started with Common Lisp --- -We'll begin with presenting easy steps to install a development environment and to start a new Common Lisp project. +We'll begin by presenting easy steps to install a development environment and to start a new Common Lisp project. -Want a 2-clicks install? Then get +Want a 2-click install? Then get [Portacle](https://shinmera.github.io/portacle/), *a portable and multi-platform* Common Lisp environment. It ships Emacs, SBCL (the implementation), Quicklisp (package manager), SLIME (IDE) and @@ -18,9 +18,9 @@ If you don't know which implementation of Common Lisp to use, try SBCL: apt-get install sbcl -Common Lisp has been standardized via an ANSI document, so it can be -implemented in different ways. See -[Wikipedia's list of implementations](https://en.wikipedia.org/wiki/Common_Lisp#Implementations). +Common Lisp is an ANSI standard but implementations can vary greatly in what +they provide in addition to the standard. See [Wikipedia's list of +implementations](https://en.wikipedia.org/wiki/Common_Lisp#Implementations). The following implementations are packaged for Debian and most other popular Linux distributions: @@ -31,7 +31,7 @@ The following implementations are packaged for Debian and most other popular Lin Other well-known implementations include: * [ABCL](http://abcl.org/), to interface with the JVM, -* [ClozureCL](https://ccl.clozure.com/), a good implementation with very fast build times (see this [Debian package for Clozure CL](http://mr.gy/blog/clozure-cl-deb.html)), +* [ClozureCL](https://ccl.clozure.com/), a good implementation with very fast build times, * [CLASP](https://github.com/drmeister/clasp), that interoperates with C++ libraries using LLVM for compilation to native code, * [AllegroCL](https://franz.com/products/allegrocl/) (proprietary) * [LispWorks](http://www.lispworks.com/) (proprietary) From 44ed87bca0fb4c6e9d670930edc18f115c3bba65 Mon Sep 17 00:00:00 2001 From: Carl Gay Date: Mon, 29 Apr 2024 12:50:55 -0400 Subject: [PATCH 6/6] make-cookbook.lisp: fix comment - no need to call (generate) --- make-cookbook.lisp | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/make-cookbook.lisp b/make-cookbook.lisp index c256c760..cbe898b2 100644 --- a/make-cookbook.lisp +++ b/make-cookbook.lisp @@ -3,8 +3,7 @@ ;; pandoc to epub ;; calibre from epub to pdf ;; -;; To generate the EPUB, load this file and call -;; (generate) +;; To generate the EPUB, just load this file. ;; ;; Metadata is in metadata.txt ;; -> change the date