summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBozhidar Batsov <bozhidar@tradeo.com>2013-10-24 18:16:43 +0300
committerBozhidar Batsov <bozhidar@tradeo.com>2013-10-24 18:16:43 +0300
commitf37905fad73f4fb3fa1af0007c6175606fce59a5 (patch)
tree0d066b3367018eea5a08ee15fd48335b1285392d /README.md
parentd5ccf0e2d409f0f7f57aa336f3e410803610661b (diff)
[Fix #400] Provide instructions for upgrading from nrepl.el to CIDER
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 19 insertions, 19 deletions
diff --git a/README.md b/README.md
index 733c06ab..1786c4ab 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,15 @@ of SLIME + [swank-clojure](https://github.com/technomancy/swank-clojure).
## Installation
+#### Upgrading from nrepl.el
+
+Before installing CIDER make sure you've removed the old `nrepl.el`
+package and all packages that depend on it. Use only packages updated to work with CIDER!
+
+You'll also need to adjust your config accordingly, as most settings
+were renamed in CIDER. Consult the **Configuration** section of the
+README for more details.
+
### Via package.el
`package.el` is the built-in package manager in Emacs 24+. On Emacs 23
@@ -19,26 +28,11 @@ maintained repos -
[Marmalade](http://marmalade-repo.org/packages/cider) and
[MELPA](http://melpa.milkbox.net).
-If you're not already using Marmalade, add this to your
-`~/.emacs.d/init.el` (or equivalent) and load it with <kbd>M-x eval-buffer</kbd>.
-
-```el
-(require 'package)
-(add-to-list 'package-archives
- '("marmalade" . "http://marmalade-repo.org/packages/"))
-(package-initialize)
-```
+If you're not already using one of them, follow their installation instructions:
+[Marmalade](http://marmalade-repo.org/),
+[MELPA](http://melpa.milkbox.net/#/getting-started).
-For MELPA the code you need to add is:
-
-```el
-(require 'package)
-(add-to-list 'package-archives
- '("melpa" . "http://melpa.milkbox.net/packages/") t)
-(package-initialize)
-```
-
-And then you can install `CIDER` with the following command:
+You can install `CIDER` with the following command:
<kbd>M-x package-install [RET] cider [RET]</kbd>
@@ -53,6 +47,12 @@ If the installation doesn't work try refreshing the package list:
<kbd>M-x package-refresh-contents [RET]</kbd>
+Keep in mind that MELPA packages are built automatically from
+the `master` branch, meaning bugs might creep in there from time to
+time. Never-the-less, installing from MELPA is the recommended way of
+obtaining CIDER, as the `master` branch is normally quite stable and
+"stable" (tagged) builds are released somewhat infrequently.
+
### Via el-get
[el-get](https://github.com/dimitri/el-get) is another popular package manager for Emacs.