| 
4 | 4 | excellent support for Clojure programming and is widely used within  | 
5 | 5 | the Clojure community.  | 
6 | 6 | 
 
  | 
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)  | 
0 commit comments