From 38ea1385428fae2ed4dbbf6315980fd8743aa601 Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Sun, 23 Feb 2020 16:24:11 -0500 Subject: [PATCH] lang/clojure: add README #1166 --- docs/modules.org | 2 +- modules/lang/clojure/README.org | 62 +++++++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+), 1 deletion(-) create mode 100644 modules/lang/clojure/README.org diff --git a/docs/modules.org b/docs/modules.org index 42045eb3f..1e4249e76 100644 --- a/docs/modules.org +++ b/docs/modules.org @@ -92,7 +92,7 @@ Modules that bring support for a language or group of languages to Emacs. + [[file:../modules/lang/agda/README.org][agda]] - TODO + assembly - TODO + [[file:../modules/lang/cc/README.org][cc]] =+lsp= - TODO -+ clojure =+lsp= - TODO ++ [[file:/mnt/projects/conf/doom-emacs/modules/lang/clojure/README.org][clojure]] =+lsp= - TODO + common-lisp - TODO + [[file:../modules/lang/coq/README.org][coq]] - TODO + crystal - TODO diff --git a/modules/lang/clojure/README.org b/modules/lang/clojure/README.org new file mode 100644 index 000000000..08d5f3227 --- /dev/null +++ b/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.