Commit fa030020 authored by Eric Timmons's avatar Eric Timmons
Browse files

Update maintainer to point to cl-docker-images project

parent b28e44e6
Pipeline #2669 passed with stages
in 2 minutes and 5 seconds
- [Supported Tags](#org907d13e)
- [Simple Tags](#orgeb70d97)
- [Shared Tags](#orgace1f45)
- [Quick Reference](#org4df6258)
- [What is SBCL?](#org8b2973b)
- [How to use this image](#orgaa14668)
- [Create a `Dockerfile` in your SBCL project](#orga537293)
- [Run a single Common Lisp script](#org1ca3d1f)
- [Developing using SLIME](#org88a70cc)
- [What's in the image?](#org23a6f0c)
- [Image variants](#org007de56)
- [`%%IMAGE%%:<version>`](#orgdd7be09)
- [`%%IMAGE%%:<version>-slim`](#org4102d00)
- [`%%IMAGE%%:<version>-alpine`](#org08d981c)
- [`%%IMAGE%%:<version>-windowsservercore`](#org3383891)
- [License](#orgbfac149)
<a id="org907d13e"></a>
- [Supported Tags](#org095cb2b)
- [Simple Tags](#org222794e)
- [Shared Tags](#org5d57c38)
- [Quick Reference](#org5bc0468)
- [What is SBCL?](#orgf55eeec)
- [How to use this image](#orgf2f237c)
- [Create a `Dockerfile` in your SBCL project](#orgae31fdc)
- [Run a single Common Lisp script](#orgfb53bb2)
- [Developing using SLIME](#orgdd7ec47)
- [What's in the image?](#org5e9bd7b)
- [Image variants](#org813dcc2)
- [`%%IMAGE%%:<version>`](#orga9c9565)
- [`%%IMAGE%%:<version>-slim`](#org60b749c)
- [`%%IMAGE%%:<version>-alpine`](#orgb1d1eac)
- [`%%IMAGE%%:<version>-windowsservercore`](#orgb9753c1)
- [License](#org54305a9)
<a id="org095cb2b"></a>
# Supported Tags
<a id="orgeb70d97"></a>
<a id="org222794e"></a>
## Simple Tags
INSERT-SIMPLE-TAGS
<a id="orgace1f45"></a>
<a id="org5d57c38"></a>
## Shared Tags
INSERT-SHARED-TAGS
<a id="org4df6258"></a>
<a id="org5bc0468"></a>
# Quick Reference
- **SBCL Home Page:** [http://sbcl.org](http://sbcl.org)
- **Where to file Docker image related issues:** <https://gitlab.common-lisp.net/cl-docker-images/sbcl>
- **Where to file issues for SBCL itself:** [https://bugs.launchpad.net/sbcl](https://bugs.launchpad.net/sbcl)
- **Maintained by:** [Eric Timmons](https://github.com/daewok)
- **Maintained by:** [CL Docker Images Project](https://common-lisp.net/project/cl-docker-images)
- **Supported platforms:** `linux/amd64`, `linux/arm64/v8`, `linux/arm/v7`, `windows/amd64`
<a id="org8b2973b"></a>
<a id="orgf55eeec"></a>
# What is SBCL?
......@@ -56,12 +56,12 @@ From [SBCL's Home Page](http://sbcl.org):
> Steel Bank Common Lisp (SBCL) is a high performance Common Lisp compiler. It is open source / free software, with a permissive license. In addition to the compiler and runtime system for ANSI Common Lisp, it provides an interactive environment including a debugger, a statistical profiler, a code coverage tool, and many other extensions.
<a id="orgaa14668"></a>
<a id="orgf2f237c"></a>
# How to use this image
<a id="orga537293"></a>
<a id="orgae31fdc"></a>
## Create a `Dockerfile` in your SBCL project
......@@ -80,7 +80,7 @@ $ docker run -it --rm --name my-running-app my-sbcl-app
```
<a id="org1ca3d1f"></a>
<a id="orgfb53bb2"></a>
## Run a single Common Lisp script
......@@ -91,7 +91,7 @@ $ docker run -it --rm --name my-running-script -v "$PWD":/usr/src/app -w /usr/sr
```
<a id="org88a70cc"></a>
<a id="orgdd7ec47"></a>
## Developing using SLIME
......@@ -108,7 +108,7 @@ M-x slime-connect RET RET RET
```
<a id="org23a6f0c"></a>
<a id="org5e9bd7b"></a>
# What's in the image?
......@@ -117,14 +117,14 @@ This image contains SBCL binaries built from the latest source code released by
Currently, the only modification made to the SBCL source code when building is to remove `-march=armv5` from the `CFLAGS` on 32-bit ARM targets. This is done because recent gcc versions (like the ones in Alpine 3.11 and 3.12) no longer support this target and it can create suboptimal binaries for armv7 (which is the explicit target of these Docker images). This issue has been [reported upstream](https://bugs.launchpad.net/sbcl/+bug/1839783).
<a id="org007de56"></a>
<a id="org813dcc2"></a>
# Image variants
This image comes in several variants, each designed for a specific use case.
<a id="orgdd7be09"></a>
<a id="orga9c9565"></a>
## `%%IMAGE%%:<version>`
......@@ -137,14 +137,14 @@ These images are built off the buildpack-deps image. It, by design, has a large
These images contain the Quicklisp installer, located at `/usr/local/share/common-lisp/source/quicklisp/quicklisp.lisp`.
<a id="org4102d00"></a>
<a id="org60b749c"></a>
## `%%IMAGE%%:<version>-slim`
This image does not contain the common packages contained in the default tag and only contains the minimal packages needed to run SBCL. Unless you are working in an environment where only this image will be deployed and you have space constraints, we highly recommend using the default image of this repository.
<a id="org08d981c"></a>
<a id="orgb1d1eac"></a>
## `%%IMAGE%%:<version>-alpine`
......@@ -155,7 +155,7 @@ This variant is highly recommended when final image size being as small as possi
To minimize image size, it's uncommon for additional related tools (such as git or bash) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [alpine image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
<a id="org3383891"></a>
<a id="orgb9753c1"></a>
## `%%IMAGE%%:<version>-windowsservercore`
......@@ -167,7 +167,7 @@ For information about how to get Docker running on Windows, please see the relev
- [Windows 10 Quick Start](https://msdn.microsoft.com/en-us/virtualization/windowscontainers/quick_start/quick_start_windows_10)
<a id="orgbfac149"></a>
<a id="org54305a9"></a>
# License
......
......@@ -16,7 +16,7 @@
+ SBCL Home Page :: [[http://sbcl.org][http://sbcl.org]]
+ Where to file Docker image related issues :: [[https://gitlab.common-lisp.net/cl-docker-images/sbcl]]
+ Where to file issues for SBCL itself :: [[https://bugs.launchpad.net/sbcl][https://bugs.launchpad.net/sbcl]]
+ Maintained by :: [[https://github.com/daewok][Eric Timmons]]
+ Maintained by :: [[https://common-lisp.net/project/cl-docker-images][CL Docker Images Project]]
+ Supported platforms :: =linux/amd64=, =linux/arm64/v8=, =linux/arm/v7=, =windows/amd64=
* What is SBCL?
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment