From d1eef83124759ee4efa5e37b8406dcb5d71f8c98 Mon Sep 17 00:00:00 2001 From: Bozhidar Batsov Date: Fri, 26 Oct 2018 10:39:17 +0200 Subject: Improve some formatting in the manual --- doc/installation.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'doc/installation.md') diff --git a/doc/installation.md b/doc/installation.md index dd62a75c..8ebcbf47 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -130,9 +130,11 @@ CIDER takes care of injecting it and its other dependencies. **`profiles.clj` or `profile.boot` don't need to be modified anymore for the above use case!** -If you don't want `cider-jack-in` to inject dependencies automatically, set -`cider-inject-dependencies-at-jack-in` to `nil`. Note that you'll have to setup -the dependencies yourself (see the section below), just as in CIDER 0.10 and older. +!!! Tip + + If you don't want `cider-jack-in` to inject dependencies automatically, set + `cider-inject-dependencies-at-jack-in` to `nil`. Note that you'll have to setup + the dependencies yourself (see the section below), just as in CIDER 0.10 and older. CIDER can also inject a Clojure dependency into your project, which is useful, for example, if your project defaults to an older version of Clojure than that @@ -168,6 +170,11 @@ A minimal `profiles.clj` for CIDER would be: #### Using Boot +!!! Note + + It's highly recommended to use Boot 2.8.2 or newer, as 2.8.2 is the first + release to ship with nREPL 0.4. + Boot users can configure the tool to include the middleware automatically in all of their projects using a `~/.boot/profile.boot` file like so: -- cgit v1.2.3 From 99f0c62b3edc3c03ef7ef3dbfb581aef0c4c6caf Mon Sep 17 00:00:00 2001 From: Andrea Richiardi Date: Sat, 17 Nov 2018 12:29:47 -0800 Subject: Improve the Makefile autoload and compilation sections Inspired by the immense magit, we now have a similar way to build the autoloads.el file and additionally we combine both autoload and compilation steps under the build target. With this change, manual installation and tools like borg can just call make and have everything ready for consumption. --- doc/installation.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) (limited to 'doc/installation.md') diff --git a/doc/installation.md b/doc/installation.md index 8ebcbf47..82aa91b7 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -114,11 +114,10 @@ following command: ## Manual installation -Installing CIDER manually is discouraged unless you plan to work with -CIDER's codebase. The manual installation is relatively involved as it -requires manual installation of the dependencies and manual generation -of the package autoloads. Check out the section [Hacking on -CIDER](hacking_on_cider.md) for more details. +Installing CIDER manually is discouraged unless you plan to work with CIDER's +codebase. The manual installation is relatively involved as it requires manual +installation of the dependencies. Check out the section +[Hacking on CIDER](hacking_on_cider.md) for more details. ## CIDER's nREPL middleware -- cgit v1.2.3 From a72478a5a1679e23579bc44b7cc7b9cbf06110da Mon Sep 17 00:00:00 2001 From: Dave Roberts Date: Sun, 2 Dec 2018 03:45:14 -0800 Subject: Deep editing pass on documentation (#2531) --- doc/installation.md | 78 +++++++++++++++++++++++++++++------------------------ 1 file changed, 43 insertions(+), 35 deletions(-) (limited to 'doc/installation.md') diff --git a/doc/installation.md b/doc/installation.md index 82aa91b7..3727fbf7 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -4,8 +4,8 @@ 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 +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 C-h t). @@ -14,8 +14,8 @@ CIDER officially supports Emacs 25.1+, Java 8+ and Clojure(Script) Java 7 and Clojure(Script) 1.7. You'll also need a recent version of either the Clojure CLI tools or 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. +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 the latest stable versions. !!! warning @@ -44,11 +44,20 @@ If the installation doesn't work try refreshing the package list: M-x package-refresh-contents [RET] -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. +It's important to note that MELPA packages are built automatically +from the `master` branch, and that means you'll be right on the +leading edge of development. This has upsides and downsides; you'll +see new features first, but you might experience some bugs from +time to time. Nevertheless, installing from MELPA is a reasonable way +to obtain CIDER. The `master` branch is normally quite stable +and serious regressions there are usually fixed quickly. + +If you have concerns about living on the leading edge of CIDER +deveopment, you can always pin CIDER to use MELPA Stable like this: + +```el +(add-to-list 'package-pinned-packages '(cider . "melpa-stable") t) +``` !!! Tip @@ -57,15 +66,6 @@ and serious regressions there are usually fixed pretty quickly. [this article](http://emacsredux.com/blog/2015/05/10/building-melpa-packages-locally/) for details on the subject. -Generally, users of the non-adventurous kind are advised to stick -with the stable releases, available from MELPA Stable. -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) -``` - !!! note CIDER has dependencies (e.g. `queue` & `seq`) that are only available in the @@ -112,22 +112,25 @@ following command: M-x el-get-install [RET] cider [RET] -## Manual installation +## Manual Installation Installing CIDER manually is discouraged unless you plan to work with CIDER's codebase. The manual installation is relatively involved as it requires manual installation of the dependencies. Check out the section [Hacking on CIDER](hacking_on_cider.md) for more details. -## CIDER's nREPL middleware +## CIDER's nREPL Middleware -Much of CIDER's functionality depends on the presence of CIDER's own -[nREPL +Much of CIDER's functionality depends on its own [nREPL middleware](https://github.com/clojure-emacs/cider-nrepl). Starting -with version 0.11, When `cider-jack-in` (C-c C-x (C-)j (C-)j) is used, -CIDER takes care of injecting it and its other dependencies. +with version 0.11, `cider-jack-in` (C-c C-x (C-)j (C-)j) +automatically injects this middle and other dependencies as required. -**`profiles.clj` or `profile.boot` don't need to be modified anymore for the above use case!** +!!! Note + In the past, if you were setting up CIDER, you might have had to + modify `profiles.clj` or `profile.boot`. CIDER now handles + everything automatically and you don't need to add anything + special to these files. !!! Tip @@ -140,11 +143,12 @@ for example, if your project defaults to an older version of Clojure than that supported by the CIDER middleware. Set `cider-jack-in-auto-inject-clojure` appropriately to enable this. -If a standalone REPL is preferred, you need to invoke `cider-connect` (instead -of `cider-jack-in`) and you'll need to manually add the dependencies to your -Clojure project (explained in the following section). +If you prefer a standalone REPL, you will need to invoke +`cider-connect` instead of `cider-jack-in` and manually add the +dependencies to your Clojure project (explained in the following +section). -### Setting up a standalone REPL +### Setting Up a Standalone REPL #### Using Leiningen @@ -189,9 +193,9 @@ all of their projects using a `~/.boot/profile.boot` file like so: For more information visit [boot-clj wiki](https://github.com/boot-clj/boot/wiki/Cider-REPL). -### Using embedded nREPL server +### Using Embedded nREPL Server -If you're embedding nREPL in your application you'll have to start the +If you're embedding nREPL in your application, you'll have to start the server with CIDER's own nREPL handler. ```clojure @@ -208,8 +212,12 @@ It goes without saying that your project should depend on `cider-nrepl`. !!! note - `x.y.z` should be compatible with the version of CIDER you're currently using. - The required version can be checked in `cider-required-middleware-version`. Prior to CIDER 0.18, CIDER and cider-nrepl were always released together - and their versions had to match for things to work, but as the prominence - of cider-nrepl grew and many other tools started using, this was changed. + and their versions had to match for things to work. But as the prominence + of cider-nrepl grew and many other tools started using it, the two + projects evolved separately and are no longer in tight + lock-step. Any recent version of cider-nrepl should be compatible + with a recent version of CIDER. You can check the required version + of cider-nrepl for your version of CIDER by looking at + `cider-required-middleware-version`. + -- cgit v1.2.3 From 91210f6866c8f034b956eac74694db8ea28d3b9a Mon Sep 17 00:00:00 2001 From: Bozhidar Batsov Date: Tue, 1 Jan 2019 12:07:31 +0200 Subject: Release 0.19 --- doc/installation.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'doc/installation.md') diff --git a/doc/installation.md b/doc/installation.md index 3727fbf7..2f694a97 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -126,7 +126,7 @@ middleware](https://github.com/clojure-emacs/cider-nrepl). Starting with version 0.11, `cider-jack-in` (C-c C-x (C-)j (C-)j) automatically injects this middle and other dependencies as required. -!!! Note +!!! Note In the past, if you were setting up CIDER, you might have had to modify `profiles.clj` or `profile.boot`. CIDER now handles everything automatically and you don't need to add anything @@ -152,6 +152,11 @@ section). #### Using Leiningen +!!! Note + + It's highly recommended to use Leiningen 2.8.3 or newer, as 2.8.3 is the first + release to ship with nREPL 0.5. + Use the convenient plugin for defaults, either in your project's `project.clj` file or in the :repl profile in `~/.lein/profiles.clj`. @@ -162,7 +167,7 @@ Use the convenient plugin for defaults, either in your project's A minimal `profiles.clj` for CIDER would be: ```clojure -{:repl {:plugins [[cider/cider-nrepl "0.18.0"]]}} +{:repl {:plugins [[cider/cider-nrepl "0.19.0"]]}} ``` !!! warning @@ -185,7 +190,7 @@ all of their projects using a `~/.boot/profile.boot` file like so: (require 'boot.repl) (swap! boot.repl/*default-dependencies* - concat '[[cider/cider-nrepl "0.18.0"]]) + concat '[[cider/cider-nrepl "0.19.0"]]) (swap! boot.repl/*default-middleware* conj 'cider.nrepl/cider-middleware) @@ -220,4 +225,3 @@ It goes without saying that your project should depend on `cider-nrepl`. with a recent version of CIDER. You can check the required version of cider-nrepl for your version of CIDER by looking at `cider-required-middleware-version`. - -- cgit v1.2.3