Permalink
Browse files

Readme updates.

  • Loading branch information...
1 parent 6fdc322 commit 567a4f7254ebb5aea86a64b4ae8a474153140a39 @technomancy committed Jan 1, 2010
Showing with 33 additions and 17 deletions.
  1. +10 −6 README.md
  2. +4 −3 TODO.org
  3. +19 −8 swank-clojure.el
View
@@ -12,7 +12,7 @@ Depending on what you're using it for, Swank Clojure can be invoked in
a few different ways:
1. Standalone Session: If you just hit M-x slime, swank-clojure will
- download the jars for Clojure 1.0, contrib, and swank-clojure,
+ download the jars for Clojure, contrib, and swank-clojure,
launch an instance, and connect to it. If you just want to try out
Clojure, this is all you need. Just get Swank Clojure through
[ELPA](http://tromey.com/elpa) and stop reading here. =)
@@ -23,13 +23,13 @@ a few different ways:
3. Project: Put your project's dependencies in the lib/ directory,
(either manually or using
- [leiningen](http://github.com/technomancy/leiningen) or Maven) then
+ [Leiningen](http://github.com/technomancy/leiningen) or Maven) then
launch M-x swank-clojure-project. Note that you must have
swank-clojure.jar in the lib/ directory, it will not automatically
add itself to the classpath as it did in past versions that had to
run from a checkout.
-4. Standalone Server: Users of leiningen or clojure-maven-plugin can
+4. Standalone Server: Users of Leiningen or clojure-maven-plugin can
[launch a server from a
shell](http://wiki.github.com/technomancy/leiningen/emacs-integration)
and connect to it from within Emacs using M-x slime-connect.
@@ -57,6 +57,9 @@ has been a standard piece of the Emacs ecosystem for a while
now. See the "Installing from Source" section below if you wish to
hack on a development version that hasn't been released yet.
+Be sure you don't have old versions of SLIME either manually installed
+or installed using a system-wide package manager like apt-get.
+
## Project Layout
If you intend to use M-x swank-clojure-project, it will prompt for a
@@ -92,11 +95,12 @@ own code, and connect via Emacs to that instance:
Then use M-x slime-connect to connect from within Emacs.
You can also start the server directly from the "java" command-line
-launcher if you use "swank.swank" as your main class.
+launcher if you AOT-compile it and specify "swank.swank" as your main
+class.
## Commands
-Commonly-used commands:
+Commonly-used SLIME commands:
* **M-TAB**: Autocomplete symbol at point
* **C-x C-e**: Eval the form under the point
@@ -105,7 +109,7 @@ Commonly-used commands:
* **C-c S-i**: Inspect a value
* **C-c C-m**: Macroexpand the call under the point
* **C-c C-d C-d**: Look up documentation for a var
-* **C-c C-z**: Switch to the repl buffer
+* **C-c C-z**: Switch from a Clojure buffer to the repl buffer
* **C-c M-p**: Switch the repl namespace to match the current buffer
Pressing "v" on a stack trace a debug buffer will jump to the file and
View
@@ -1,15 +1,16 @@
TODO
-* Packaging (elpa branch)
-** TODO Upload jars to better host?
-** TODO Submit to ELPA
* New commands
** unmap-ns
** classpath-completion (unify with import)
** unknown vars should search known namespaces and prompt for use insertion
+ Maybe implement as a restart?
** M-. should work for namespaces
** xref for all callers of a function?
+* Piggyback elisp code in jars
+* Integrate with debug-repl
* Known bugs
+** TODO SLIME Inspector breaks in Emacs 22
** TODO *in* only works from *inferior-lisp*
** TODO certain project classes break class-browse: (unconfirmed)
http://groups.google.com/group/swank-clojure/msg/7ab11f8698ad52d9
View
@@ -17,18 +17,29 @@
;;
;; The purpose of this file is to set up `slime-lisp-implementations'
;; to allow SLIME to communicate with the Swank server implemented in
-;; Clojure. There are three ways to launch SLIME:
+;; Clojure. There are four ways to launch a session:
;;
-;; 1. Standalone M-x slime: swank-clojure will download the jars for
-;; Clojure 1.0, contrib, and swank-clojure and connect to it. Good
-;; for beginners wanting to try things out!
+;; 1. Standalone: If you just hit M-x slime, swank-clojure will
+;; download the jars for Clojure, contrib, and swank-clojure,
+;; launch an instance, and connect to it. If you just want to try
+;; out Clojure, this is all you need. Just get Swank Clojure
+;; through ELPA (http://tromey.com/elpa) and stop reading here.
;;
-;; 2. Custom classpath: If you have your own newer copies of Clojure
-;; and other jars you'd like to use, set swank-clojure-classpath to
-;; point to them, then hit M-x slime.
+;; 2. Custom classpath: If you want to hack on Clojure or Contrib, set
+;; swank-clojure-classpath to a list of paths to the jars you want to
+;; use and then hit M-x slime.
;;
;; 3. Project: Put your project's dependencies in the lib/ directory,
-;; then launch M-x swank-clojure-project.
+;; (either manually or using Leiningen or Maven) then launch
+;; M-x swank-clojure-project. Note that you must have
+;; swank-clojure.jar in the lib/ directory, it will not
+;; automatically add itself to the classpath as it did in past
+;; versions that had to run from a checkout.
+;;
+;; 4. Standalone Server: Users of leiningen or clojure-maven-plugin
+;; can launch a server from a shell
+;; (http://wiki.github.com/technomancy/leiningen/emacs-integration)
+;; and connect to it from within Emacs using M-x slime-connect.
;;
;;; Code:
;;

0 comments on commit 567a4f7

Please sign in to comment.