Skip to content

Commit 576ca21

Browse files
committed
Point people to clojure-doc.org instead.
1 parent 7ce149c commit 576ca21

File tree

6 files changed

+20
-163
lines changed

6 files changed

+20
-163
lines changed

README.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
Provides Emacs font-lock, indentation, and navigation for the
44
[Clojure programming language](http://clojure.org).
55

6+
A more thorough walkthrough is available at [clojure-doc.org](http://clojure-doc.org/articles/tutorials/emacs.html)
7+
68
## Installation
79

810
Available on both [Marmalade](http://marmalade-repo.org/packages/clojure-mode) and
@@ -35,6 +37,7 @@ of code instead:
3537
And then you can install:
3638

3739
<kbd>M-x package-refresh-contents</kbd>
40+
3841
<kbd>M-x package-install [RET] clojure-mode [RET]</kbd>
3942

4043
or if you'd rather keep it in your dotfiles:
@@ -53,10 +56,9 @@ and `require`ing it.
5356

5457
This source repository also includes `clojure-test-mode.el`, which
5558
provides support for running Clojure tests (using the `clojure.test`
56-
framework) via nrepl.el or SLIME and seeing feedback in the test
57-
buffer about which tests failed or errored. The installation
58-
instructions above should work for clojure-test-mode as well.
59-
(nrepl.el support is still in progress.)
59+
framework) via nrepl.el and seeing feedback in the test buffer about
60+
which tests failed or errored. The installation instructions above
61+
should work for clojure-test-mode as well.
6062

6163
Once you have a repl session active, you can run the tests in the
6264
current buffer with <kbd>C-c C-,</kbd>. Failing tests and errors will be
@@ -77,26 +79,29 @@ its tests would be in `test/my/project/frob_test.clj` in the
7779
## Paredit
7880

7981
Using clojure-mode with
80-
[paredit](http://mumble.net/~campbell/emacs/paredit.el) is highly
81-
recommended. It is also available using package.el from the above
82-
archives.
82+
[Paredit](http://mumble.net/~campbell/emacs/paredit.el) is highly
83+
recommended. It helps ensure the structure of your forms is not
84+
compromised and offers a number of operations that work on code
85+
structure at a higher level than just characters and words.
86+
87+
It is also available using package.el from the above archives.
8388

84-
Use paredit as you normally would any other minor mode; for instance:
89+
Use Paredit as you normally would any other minor mode; for instance:
8590

8691
```lisp
8792
;; (require 'paredit) if you didn't install it via package.el
8893
(add-hook 'clojure-mode-hook 'paredit-mode)
8994
```
9095

9196
See [the cheat sheet](http://www.emacswiki.org/emacs/PareditCheatsheet)
92-
for paredit usage hints.
97+
for Paredit usage hints.
9398

9499
## REPL Interaction
95100

96101
A number of options exist for connecting to a running Clojure process
97102
and evaluating code interactively.
98103

99-
## Basic REPL
104+
### Basic REPL
100105

101106
Use <kbd>M-x run-lisp</kbd> to open a simple REPL subprocess using
102107
[Leiningen](http://github.com/technomancy/leiningen). Once that has
@@ -106,18 +111,18 @@ opened, you can use <kbd>C-c C-r</kbd> to evaluate the region or
106111
If you don't use Leiningen, you can set `inferior-lisp-program` to
107112
a different REPL command.
108113

109-
## nrepl.el
114+
### nrepl.el
110115

111116
You can also use [Leiningen](http://leiningen.org) to start an
112117
enhanced REPL via [nrepl.el](https://github.com/kingtim/nrepl.el).
113118

114-
## Ritz
119+
### Ritz
115120

116121
Another option is [Ritz](https://github.com/pallet/ritz), which is a
117122
bit more complicated but offers advanced debugging functionality using
118123
SLIME.
119124

120-
## Swank Clojure
125+
### Swank Clojure
121126

122127
SLIME is available via
123128
[swank-clojure](http://github.com/technomancy/swank-clojure) in `clojure-mode` 1.x.

doc/gnu-linux-setup.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

doc/index.md

Lines changed: 2 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -4,100 +4,5 @@
44
excellent support for Clojure programming and is widely used within
55
the Clojure community.
66

7-
8-
## Installation
9-
10-
For installing Emacs and generally finding your way around Emacs on
11-
your platform, proceed now to one of the platform-specific docs:
12-
13-
* [GNU/Linux setup](gnu-linux-setup.md)
14-
* [Mac OS X setup](os-x-setup.md)
15-
* [MS Windows setup](ms-windows-setup.md)
16-
17-
18-
## Configuration Overview
19-
20-
Your main Emacs config and package directory is `~/.emacs.d`.
21-
Create this directory if it does not already exist.
22-
23-
Your main Emacs config file is `~/.emacs.d/init.el`. You may create
24-
this file if it does not already exist.
25-
26-
Once you've got Emacs installed, typical configuration for use
27-
with Clojure includes:
28-
29-
* enabling the use of a remote Emacs package repository
30-
* installing clojure-mode (provides support for syntax highlighting
31-
and proper indentation for Clojure files (.clj files))
32-
* optionally enabling paredit mode (advanced support for working with
33-
expressions in parentheses/brackets)
34-
35-
and then deciding if you want to use an interactive interface to the
36-
Clojure repl from inside of Emacs. If you want this, the two routes to
37-
choose from are:
38-
39-
* use the "inferior-lisp" mode, or
40-
* use SLIME and Swank
41-
42-
See below for discussion on each of these options.
43-
44-
45-
## Package Repository
46-
47-
Emacs packages extend the editor in various ways, and (as of version
48-
24) Emacs can install them from a remote repository. All the packages
49-
we'll need here can be found in the [Melpa](http://melpa.milkbox.net/)
50-
repository. Tell Emacs about melpa by adding the following to your
51-
`~/.emacs.d/init.el` file:
52-
53-
```lisp
54-
(require 'package)
55-
(add-to-list 'package-archives
56-
'("melpa" . "http://melpa.milkbox.net/packages/") t)
57-
(package-initialize)
58-
```
59-
60-
61-
## Clojure Mode
62-
63-
Emacs uses so-called "major modes" (as in, "mode of operation") to
64-
provide filetype-specific editor support. For example, you edit a Java
65-
file using the Emacs java mode, and Clojure using a clojure mode.
66-
Emacs doesn't come with a Clojure mode by default, so we must install it.
67-
68-
Install clojure-mode while running Emacs. Hit <kbd>M-x package-install
69-
RET clojure-mode</kbd>. After doing this, Emacs should automatically
70-
recognize .clj files as Clojure files when you open them.
71-
72-
See [Clojure Mode's readme](https://github.com/technomancy/clojure-mode/blob/master/README.md) for more info on using it.
73-
74-
75-
## Paredit Mode
76-
77-
todo
78-
79-
80-
## Clojure Test Mode
81-
82-
todo
83-
84-
85-
# REPL Interaction
86-
87-
If you like, you can simply interact with the Clojure repl that
88-
[Leiningen](http://leiningen.org/index.html) provides for you (via
89-
`lein repl`) --- totally separate from Emacs or in a shell buffer.
90-
However, Emacs can provide access to the repl from within a
91-
clojure-mode buffer if you prefer:
92-
93-
* The simplest way to interact with the repl from within Emacs is to
94-
[use inferior-lisp](inferior-lisp.md).
95-
96-
* For more functionality, [use slime & swank](https://github.com/technomancy/swank-clojure/blob/master/README.md).
97-
98-
99-
# Detailed Emacs Documentation
100-
101-
GNU Emacs provides excellent built-in documention which is available
102-
within the editor (see "C-h") and also
103-
[online](http://www.gnu.org/software/emacs/manual/html_node/emacs/index.html).
7+
The documentation here has been replaced by
8+
[the Emacs tutorial at clojure-doc.org](http://clojure-doc.org/articles/tutorials/emacs.html)

doc/inferior-lisp.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

doc/ms-windows-setup.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

doc/os-x-setup.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)