79 lines
2.7 KiB
Markdown
79 lines
2.7 KiB
Markdown
|
[](https://travis-ci.org/slime/slime) [](http://melpa.org/#/slime) [](http://stable.melpa.org/#/slime)
|
||
|
|
|
||
|
|
Overview
|
||
|
|
--------
|
||
|
|
|
||
|
|
SLIME is the Superior Lisp Interaction Mode for Emacs.
|
||
|
|
|
||
|
|
SLIME extends Emacs with support for interactive programming in Common
|
||
|
|
Lisp. The features are centered around slime-mode, an Emacs minor-mode that
|
||
|
|
complements the standard lisp-mode. While lisp-mode supports editing Lisp
|
||
|
|
source files, slime-mode adds support for interacting with a running Common
|
||
|
|
Lisp process for compilation, debugging, documentation lookup, and so on.
|
||
|
|
|
||
|
|
For much more information, consult [the manual][1].
|
||
|
|
|
||
|
|
|
||
|
|
Quick setup instructions
|
||
|
|
------------------------
|
||
|
|
|
||
|
|
1. [Set up the MELPA repository][2], if you haven't already, and install
|
||
|
|
SLIME using `M-x package-install RET slime RET`.
|
||
|
|
|
||
|
|
2. Add the following lines to your `~/.emacs` file, filling in in
|
||
|
|
the appropriate filenames:
|
||
|
|
|
||
|
|
```el
|
||
|
|
;; Set your lisp system and, optionally, some contribs
|
||
|
|
(setq inferior-lisp-program "/opt/sbcl/bin/sbcl")
|
||
|
|
(setq slime-contribs '(slime-fancy))
|
||
|
|
```
|
||
|
|
|
||
|
|
3. Use `M-x slime` to fire up and connect to an inferior Lisp. SLIME will
|
||
|
|
now automatically be available in your Lisp source buffers.
|
||
|
|
|
||
|
|
If you'd like to contribute to SLIME, you will want to instead follow
|
||
|
|
the manual's instructions on [how to install SLIME via Git][7].
|
||
|
|
|
||
|
|
|
||
|
|
Contribs
|
||
|
|
--------
|
||
|
|
|
||
|
|
SLIME comes with additional contributed packages or "contribs".
|
||
|
|
Contribs can be selected via the `slime-contribs` list.
|
||
|
|
|
||
|
|
The most-often used contrib is `slime-fancy`, which primarily installs a
|
||
|
|
popular set of other contributed packages. It includes a better REPL, and
|
||
|
|
many more nice features.
|
||
|
|
|
||
|
|
|
||
|
|
License
|
||
|
|
-------
|
||
|
|
|
||
|
|
SLIME is free software. All files, unless explicitly stated otherwise, are
|
||
|
|
public domain.
|
||
|
|
|
||
|
|
|
||
|
|
Contact
|
||
|
|
-------
|
||
|
|
|
||
|
|
If you have problems, first have a look at the list of
|
||
|
|
[known issues and workarounds][6].
|
||
|
|
|
||
|
|
Questions and comments are best directed to the mailing list at
|
||
|
|
`slime-devel@common-lisp.net`, but you have to [subscribe][3] first. The
|
||
|
|
mailing list archive is also available on [Gmane][4].
|
||
|
|
|
||
|
|
See the [CONTRIBUTING.md][5] file for instructions on how to contribute.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
[1]: http://common-lisp.net/project/slime/doc/html/
|
||
|
|
[2]: http://melpa.org/#/getting-started
|
||
|
|
[3]: http://www.common-lisp.net/project/slime/#mailinglist
|
||
|
|
[4]: http://news.gmane.org/gmane.lisp.slime.devel
|
||
|
|
[5]: https://github.com/slime/slime/blob/master/CONTRIBUTING.md
|
||
|
|
[6]: https://github.com/slime/slime/issues?labels=workaround&state=closed
|
||
|
|
[7]: http://common-lisp.net/project/slime/doc/html/Installation.html#Installing-from-Git
|