branch: elpa/cider
commit 1b4c2ea60fde9b5bb94f5f4c2debf5674fa011f8
Author: Bozhidar Batsov <bozhi...@batsov.dev>
Commit: Bozhidar Batsov <bozhi...@batsov.dev>
[Docs] Add a page about ClojureCLR
---
doc/modules/ROOT/pages/platforms/clojureclr.adoc | 31 ++++++++++++++++++++++++
doc/modules/ROOT/pages/platforms/overview.adoc | 2 +-
2 files changed, 32 insertions(+), 1 deletion(-)
diff --git a/doc/modules/ROOT/pages/platforms/clojureclr.adoc
b/doc/modules/ROOT/pages/platforms/clojureclr.adoc
new file mode 100644
index 0000000000..e858f3f318
--- /dev/null
+++ b/doc/modules/ROOT/pages/platforms/clojureclr.adoc
@@ -0,0 +1,31 @@
+= ClojureCLR
+
+== Current Status
+
+ClojureCLR on CIDER is not great due to the lack of a fully-functional nREPL
+server for ClojureCLR. There are currently two options:
+
+- https://github.com/clojure/clr.tools.nrepl[clr.tools.nrepl]: A direct (but
incomplete) port of the reference Clojure nREPL server.
+-
https://github.com/arcadia-unity/Arcadia/blob/master/Editor/NRepl.cs[Arcadia's
nREPL]: A basic, but working nREPL implementation in C#.
+
+If you need to use CIDER with ClojureCLR today Arcadia's nREPL is your only
usable option. That being said - `clr.tools.nrepl` is a much
+more sophisticated project and ideally we should get it over to the finish
line.
+
+== Usage
+
+NOTE: Contributions welcome!
+
+As `cider-jack-in` doesn't support ClojureCLR projects out-of-the-box
currently, you'll need to start an nREPL server externally and
+connect to it with `cider-connect`.
+
+== Plans
+
+In an ideal world we'll achieve the following objectives:
+
+- out-of-the-box ClojureCLR support with `cider-jack-in`
+- feature parity between Clojure's nREPL implementation and `clr.tools.nrepl`
(the project can use some help)
+- adapting `cider-nrepl` for ClojureCLR (some of its codebase is JVM-specific)
+
+Given that Bozhidar's knowledge of CLR and time are limited, it'd be great if
we manage to find some volunteers to help with the
+work that's needed in this direction. In particular it'd be amazing to
complete `clr.tools.nrepl`, as the project needs relatively
+little work to be fully usable.
diff --git a/doc/modules/ROOT/pages/platforms/overview.adoc
b/doc/modules/ROOT/pages/platforms/overview.adoc
index 8583aeba58..1903cd719e 100644
--- a/doc/modules/ROOT/pages/platforms/overview.adoc
+++ b/doc/modules/ROOT/pages/platforms/overview.adoc
@@ -27,7 +27,7 @@ Right now CIDER the supports to some extent the following:
* xref:platforms/babashka.adoc[Babashka]
* xref:platforms/nbb.adoc[nbb]
-* ClojureCLR (via Arcadia's nREPL server)
+* xref:platforms/clojureclr.adoc[ClojureCLR]
* Lumo (via https://github.com/djblue/nrepl-cljs)
* xref:platforms/other_platforms.adoc[scittle, joyride & friends]
