lang/clojure: add README #1166

modules/lang/clojure/README.org

@@ -0,0 +1,62 @@
+#+TITLE:   lang/clojure
+#+DATE:    May 30, 2017
+#+SINCE:   v2.0
+#+STARTUP: inlineimages nofold
+
+* Table of Contents :TOC_3:noexport:
+- [[#description][Description]]
+  - [[#maintainers][Maintainers]]
+  - [[#module-flags][Module Flags]]
+  - [[#plugins][Plugins]]
+  - [[#hacks][Hacks]]
+- [[#prerequisites][Prerequisites]]
+- [[#features][Features]]
+- [[#configuration][Configuration]]
+- [[#troubleshooting][Troubleshooting]]
+
+* Description
+# A summary of what this module does.
+
++ If possible, include a brief list of feature highlights here
++ Like code completion, syntax checking or available snippets
++ Include links to packages & external things where possible
+
+** Maintainers
++ @username_linked_to_gihub (Author)
++ @username_linked_to_gihub
++ @username_linked_to_gihub
+
+# If this module has no maintainers, then...
+This module has no dedicated maintainers.
+
+** Module Flags
++ =+lsp= Enables LSP support. Disables cider.
+
+** Plugins
++ [[https://github.com/clojure-emacs/cider][cider]] (unless =+lsp=)
++ [[https://github.com/clojure-emacs/clj-refactor.el][clj-refactor]]
++ [[https://github.com/candid82/flycheck-joker][flycheck-joker]]
+
+** Hacks
++ Error messages emitted from CIDER are piped into the REPL buffer when it is
+  first opened, to make them easier to notice.
++ Disabled the help banner when opening the cider REPL.
+
+* Prerequisites
+This module requires:
+
++ clojure
++ With =+lsp=
+  + clojure-lsp
++ Without =+lsp=
+  + leiningen (REPL)
+  + joker (linter)
+
+* TODO Features
+# An in-depth list of features, how to use them, and their dependencies.
+
+* TODO Configuration
+# How to configure this module, including common problems and how to address them.
+
+* TODO Troubleshooting
+# Common issues and their solution, or places to look for help.