diff options
author | Sean Whitton <spwhitton@spwhitton.name> | 2018-01-20 10:12:16 -0700 |
---|---|---|
committer | Sean Whitton <spwhitton@spwhitton.name> | 2018-01-20 10:12:16 -0700 |
commit | 571e5624bbfaf33d07a5a6bc898a74ed52ace1e4 (patch) | |
tree | 68f3a8a31a4814bf926e5afb6c471a65351a74a2 /doc | |
parent | 41cf925ce1cd4833398659e58ae05c181161f8d8 (diff) |
restore and patch installation section of manual
Information about nREPL middleware is needed by the end user.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/installation.md | 117 |
1 files changed, 0 insertions, 117 deletions
diff --git a/doc/installation.md b/doc/installation.md index 09d99992..98fef5b5 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -1,120 +1,3 @@ -The canonical way to install CIDER is via `package.el` (Emacs's built-in package -manager), but it can be installed manually or via alternative package managers such -as `el-get`. - -## Prerequisites - -You'll need to have Emacs installed (preferably the latest stable -release). If you're new to Emacs you might want to go through -[the guided tour of Emacs](https://www.gnu.org/software/emacs/tour/index.html) -and the built-in tutorial (just press <kbd>C-h t</kbd>). - -CIDER officially supports Emacs 24.4+, Java 7+ and Clojure(Script) 1.7+. -CIDER 0.10 was the final release which supported Java 6 and Clojure 1.5 and 1.6. - -You'll also need a recent version of your favorite build tool (Leiningen, Boot -or Gradle) to be able to start CIDER via `cider-jack-in`. Generally it's a good -idea to use their latest stable versions. - -**CIDER does not support ClojureCLR.** - -## Installation via package.el - -CIDER is available on the two major `package.el` community -maintained repos - -[MELPA Stable](http://stable.melpa.org) -and [MELPA](http://melpa.org). - -You can install CIDER with the following command: - -<kbd>M-x package-install [RET] cider [RET]</kbd> - -or by adding this bit of Emacs Lisp code to your Emacs initialization file -(`.emacs` or `init.el`): - -```el -(unless (package-installed-p 'cider) - (package-install 'cider)) -``` - -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 a reasonable way of -obtaining CIDER, as the `master` branch is normally quite stable -and serious regressions there are usually fixed pretty quickly. - -Generally, users of the non-adventurous kind are advised to stick -with the stable releases, available from MELPA Stable. -In Emacs 24.4+, you can pin CIDER to always use MELPA -Stable by adding this to your Emacs initialization: - -```el -(add-to-list 'package-pinned-packages '(cider . "melpa-stable") t) -``` - -**CIDER has dependencies (e.g. `queue` & `seq`) that are only available in the - [GNU ELPA repository](https://elpa.gnu.org/). It's the only package repository - enabled by default in Emacs and you should not disable it!** - -## Installation via use-package - -`use-package` can be used to install CIDER via the `package.el`'s repositories -[MELPA Stable](http://stable.melpa.org) and [MELPA](http://melpa.org). - -If you wanted to install the version of CIDER which is what is to be found in -the `master` branch, declare the following in your Emacs initialization file -(`.emacs` or `init.el`): - -```el -(use-package cider - :ensure t) -``` - -However, if you wanted to be a bit more conservative and only use the stable -releases of CIDER, you'd declare the following: - -```el -(use-package cider - :ensure t - :pin melpa-stable) -``` - -After placing one of the above s-expressions, evaluate it, for it to take effect -by entering: <kbd>C-x C-e</kbd>. - -For further configuration options with `use-package`, consult the -official [use-package repository](https://github.com/jwiegley/use-package). - - -## Installation via el-get - -CIDER is also available for installation from -the [el-get](https://github.com/dimitri/el-get) package manager. - -Provided you've already installed `el-get` you can install CIDER with the -following command: - -<kbd>M-x el-get-install [RET] cider [RET]</kbd> - -## Manual installation - -Alternatively you can simply load CIDER in your Emacs straight from its source -repo. Assuming you've already obtained the code you should add something like -this to your Emacs configuration: - -```el -;; load CIDER from its source code -(add-to-list 'load-path "~/projects/cider") -(require 'cider) -``` - -Just keep in mind that you'll have to manually install all the packages CIDER -depends on in advance. - ## CIDER's nREPL middleware Much of CIDER's functionality depends on the presence of CIDER's |