add README.Debian

1 files changed, 16 insertions, 0 deletions

diff --git a/debian/elpa-cider.README.Debian b/debian/elpa-cider.README.Debian
new file mode 100644
index 00000000..f7d82a61
--- /dev/null
+++ b/debian/elpa-cider.README.Debian
@@ -0,0 +1,16 @@
+Injection of CIDER's dependencies
+=================================
+
+The usual way to start a CIDER REPL is `M-x cider-jack-in`.  This requires
+CIDER's nREPL middleware be available in your project.  CIDER can automatically
+download and inject this middleware during `M-x cider-jack-in`, but CIDER in
+Debian has this feature disabled by default to avoid surprise downloads from the
+Internet.
+
+You can either toggle the Emacs variable cider-inject-dependencies-at-jack-in to
+t in your ~/.emacs, which will enable transparent download and injection of
+CIDER's middleware, or add the middleware as dependencies of your project.  See
+the "CIDER's nREPL middleware" subsection of the "Installation" section of
+CIDER's manual.
+
+ -- Sean Whitton <spwhitton@spwhitton.name>, Sat, 20 Jan 2018 10:19:50 -0700