Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor cleanups #541

Merged
merged 6 commits into from
Apr 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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:

<!-- epub-exclude-start -->
<!-- epub-exclude-end -->
Expand Down
2 changes: 1 addition & 1 deletion STYLEGUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions fix-epub-links.sed
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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:
Expand Down
12 changes: 6 additions & 6 deletions getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:

Expand All @@ -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)
Expand Down
3 changes: 1 addition & 2 deletions make-cookbook.lisp
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down