From e4f5e73cf6b2158f74138d9030cb890adb4a39c8 Mon Sep 17 00:00:00 2001 From: Phil Hagelberg Date: Sun, 5 Jun 2011 22:40:35 -0700 Subject: [PATCH] Mention some known issues. --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 5123e43..274073a 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,12 @@ Commonly-used SLIME commands: Pressing "v" on a stack trace a debug buffer will jump to the file and line referenced by that frame if possible. +If you need help with Emacs in general, try pressing C-h t +(control-h followed by regular t) for the introductory tutorial. You +may also find the commercial +[PeepCode Emacs screencast](http://peepcode.com/products/meet-emacs) +helpful. + Note that SLIME was designed to work with Common Lisp, which has a distinction between interpreted code and compiled code. Clojure has no such distinction, so the load-file functionality is overloaded to add @@ -130,11 +136,26 @@ It will prompt you for your host (usually localhost) and port. It may also warn you that your SLIME version doesn't match your Swank version; this should be OK. +## Known Issues + +Currently having multiple versions of swank-clojure on the classpath +can cause issues when running "lein swank" or "lein jack-in". It's +recommended to not put swank-clojure in your :dev-dependencies but +have users run "lein plugin install" to have it installed +globally. + Having old versions of SLIME installed either manually or using a system-wide package manager like apt-get may cause issues. Also the official CVS version of SLIME is not supported; it often breaks compatibility with Clojure. +Not all SLIME functionality from Common Lisp is available in Clojure +at this time; in particular only a small subset of the cross-reference +commands are implemented. + +Swank-clojure and SLIME are only tested with GNU Emacs; forks such as +Aquamacs and XEmacs may work but are untested. + ## Embedding You can embed Swank Clojure in your project, start the server from