Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed assets/portacle.png
Binary file not shown.
7 changes: 0 additions & 7 deletions editor-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,6 @@ Interaction Mode for Emacs. It has support for interacting with a
running Common Lisp process for compilation, debugging, documentation
lookup, cross-references, and so on. It works with many implementations.

[Portacle](https://shinmera.github.io/portacle/) is a portable and
**multi-platform** Common Lisp environment. It ships Emacs, SBCL,
Quicklisp, SLIME and Git.

<img src="assets/portacle.png"
style="width: 800px" alt="Portacle with an open Slime REPL"/>

[plain-common-lisp](https://github.com/pascalcombier/plain-common-lisp/)
is a crafted, easy-to-install Common Lisp environment for
**Windows**. It ships Emacs, SBCL, Slime, Quicklisp. It also shows how
Expand Down
13 changes: 0 additions & 13 deletions emacs-ide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ This page is meant to provide an introduction to using [Emacs](https://www.gnu.o

We divided it roughly into 2 sections: how to use Slime or Sly, and complementary information on built-in Emacs commands to work with Lisp code.

We want to bring [Portacle](https://shinmera.github.io/portacle/) to your attention. It is a portable and
multi-platform CL development environment shipping Emacs, Slime, SBCL, git and
necessary extensions. It is a straightforward way to get going.

![](assets/emacs-teaser.png)

<!-- todo: C-u M-x slime and its configuration to work with multiple implementations -->
Expand Down Expand Up @@ -117,15 +113,6 @@ See also:
* [https://github.com/susam/emacs4cl](https://github.com/susam/emacs4cl) - a minimal Emacs configuration to get new users up and running quickly, with a tutorial.
* [https://wikemacs.org/wiki/SLIME](https://wikemacs.org/wiki/SLIME) - configuration examples and extensions.

### Portacle

[Portacle](https://shinmera.github.io/portacle/) is a portable and
multi-platform CL development environment with which you can start
developping in Lisp in a few clicks. Portacle includes Emacs, SBCL, Slime, git, and useful Emacs extensions (which-key, treeview…).

It is a straightforward way to get going.


### Doom Emacs

[Doom Emacs](https://github.com/doomemacs/doomemacs/) is a popular Emacs configuration. You can easily enable its Sly integration.
Expand Down
8 changes: 0 additions & 8 deletions getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ title: Getting started with Common Lisp

We'll begin by presenting easy steps to install a development environment and to start a new Common Lisp project.

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
Git. It's the most straightforward way to get going!

## Install an implementation

### With your package manager
Expand Down Expand Up @@ -96,8 +90,6 @@ which is a library that helps on setting that up.

All implementations above can be installed on Windows.

[Portacle](https://shinmera.github.io/portacle/) is multiplatform and works on Windows.

SBCL is available on
[Chocolatey](https://community.chocolatey.org/packages/sbcl), albeit
this is *not* an official installation method.
Expand Down
101 changes: 92 additions & 9 deletions windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,97 @@ title: Setting up Emacs on Windows or Mac

Emacs is the preferred Lisp source code editor for most CL developers.

If you want to get going easily, get
[Portacle](https://shinmera.github.io/portacle/), a **portable** and
**multi-platform** CL development environment. You get:
Read respective sections for your operating system, then read the last
section that is applicable for both.

- Emacs, slightly customized,
- Slime,
- SBCL,
- Quicklisp,
- Git.
## For macOS

You only need to download Portacle and double-click to run it.
Use [homebrew](https://brew.sh) to install Emacs, git and SBCL:

```shell
brew tap d12frosted/emacs-plus
brew install git sbcl emacs-plus
```

## For windows

Using [Chocolatey](https://chocolatey.org), install Emacs, git & SBCL:

```powershell
choco install emacs git sbcl
```

## For both macOs & Windows

This section will show you how to install Quicklisp and configure Emacs.

### Quicklisp

To download Quicklisp:

```shell
curl -O https://beta.quicklisp.org/quicklisp.lisp
```
Start SBCL REPL and install Quicklisp:

```shell
$ sbcl --load quicklisp.lisp
```
at the REPL prompt `*` enter:

```lisp
(quicklisp-quickstart:install)
```
To automatically load Quicklisp in future SBCL sessions:

```lisp
(ql:add-to-init-file)
```

Exit SBCL:
```lisp
(quit)
```

### Configure packages for Emacs

Start Emacs and the [first buffer](https://www.gnu.org/software/emacs/manual/html_node/emacs/Lisp-Interaction.html) you see is going to be called `*scratch*`. In it enter the following:

```emacs-lisp
(progn
(require 'package)

;; Add MELPA repository if not already present
(unless (assoc "melpa" package-archives)
(add-to-list 'package-archives '("melpa" . "https://melpa.org/packages/") t))

;; Initialize package system
(package-initialize)

;; Refresh package contents if needed
(unless package-archive-contents
(package-refresh-contents))

;; Install SLIME if not already installed
(unless (package-installed-p 'slime)
(package-install 'slime)
(message "SLIME installed successfully!"))

;; Basic SLIME configuration
(setq inferior-lisp-program "sbcl") ; Change to your Lisp implementation
(setq slime-contribs '(slime-fancy))

(message "SLIME setup complete! Use M-x slime to start."))
```

Move your cursor to the end of the last parenthesis and type `C-x
C-e`. That is press the `Control` key and hold it and press `x`, then
while still holding down `Control` key, press `e`, followed by
`Enter`.

The above key combination will evaluate the above Emacs Lisp
instructions to install [Slime](https://slime.common-lisp.dev), a
Emacs mode for Common Lisp development.

There is plenty more on how to configure and tweak Emacs, to your
liking, but is outside the scope of this document.