[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/clojure-ts-mode a8a321500e 13/14: More documentation updat
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/clojure-ts-mode a8a321500e 13/14: More documentation updates |
Date: |
Fri, 8 Sep 2023 18:59:18 -0400 (EDT) |
branch: elpa/clojure-ts-mode
commit a8a321500e538422aa244db13a3ba22cd8bf047f
Author: Danny Freeman <danny@dfreeman.email>
Commit: Danny Freeman <danny@dfreeman.email>
More documentation updates
Trying to be clear that the grammar should just install on it's own, but
keeping instructions for how to do it manually if necessary.
---
README.md | 21 +++++++++------------
1 file changed, 9 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index 069b3fe159..dde2547a13 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@ highlighting), indentation, and navigation support for the
## Configuration
-To see a list of available configuration options do M-x customize-group RET
clojure-ts.
+To see a list of available configuration options do `M-x customize-group <RET>
clojure-ts`.
Most configuration changes will require reverting any active clojure-ts-mode
buffers.
@@ -108,6 +108,12 @@ Once installed, evaluate clojure-ts-mode.el and you should
be ready to go.
### Install libtree-sitter-clojure shared library
+The tree-sitter clojure shared library must be available to Emacs.
+If you have `git` and a C compiler (`cc`) available on your system's `PATH`,
**then these steps should not be necessary**.
+clojure-ts-mode will install the grammar when you first open a Clojure file.
+
+If clojure-ts-mode fails to automatically install the grammar, you have the
option to install it manually.
+
#### From your OS
Some distributions may package the tree-sitter-clojure grammar in their
package repositories.
@@ -116,18 +122,9 @@ If yours does you may be able to install
tree-sitter-clojure with your system pa
If the version packaged by your OS is out of date, you may see errors in the
`*Messages*` buffer or your clojure buffers will not have any syntax
highlighting.
If this happens you should install the grammar manually with `M-x
treesit-install-language-grammar <RET> clojure`.
-#### Manually
-
-The tree-sitter clojure shared library must be available to Emacs.
-If you have `git` and a C compiler (`cc`) available on your system's `PATH`,
**then these steps should not be necessary**.
-clojure-ts-mode will install the grammar when you first open a Clojure file.
-
-If clojure-ts-mode fails to automatically install the grammar, you have the
option to install it manually.
-
-The first way is to run `M-x treesit-install-language-grammar <RET> clojure`
in Emacs.
-This is what clojure-ts-mode attempts to do when a suitable grammar is not
found.
+#### Compile From Source
-If that fails, you can attempt to download and compile manually.
+If all else fails, you can attempt to download and compile manually.
All you need is `git` and a C compiler (GCC works well).
To start, clone
[tree-sitter-clojure](https://github.com/sogaiu/tree-sitter-clojure).
- [nongnu] elpa/clojure-ts-mode updated (2225190ee5 -> 881756c8f5), ELPA Syncer, 2023/09/08
- [nongnu] elpa/clojure-ts-mode ae2e248601 01/14: First pass at semantic indentation, ELPA Syncer, 2023/09/08
- [nongnu] elpa/clojure-ts-mode ca3914aa7a 02/14: Name inline indent helper functions instead of using lambdas, ELPA Syncer, 2023/09/08
- [nongnu] elpa/clojure-ts-mode ff5d7e13dc 05/14: Semantic indentation of method implementations, ELPA Syncer, 2023/09/08
- [nongnu] elpa/clojure-ts-mode b6f6d37959 10/14: Update changelog to include information about semantic indentation, ELPA Syncer, 2023/09/08
- [nongnu] elpa/clojure-ts-mode a8a321500e 13/14: More documentation updates,
ELPA Syncer <=
- [nongnu] elpa/clojure-ts-mode 85871fdbc8 03/14: Match threading alignment of cljfmt, clojure-mode, ELPA Syncer, 2023/09/08
- [nongnu] elpa/clojure-ts-mode 64d8fde253 04/14: Semantic indentation docs, ELPA Syncer, 2023/09/08
- [nongnu] elpa/clojure-ts-mode a87821629f 07/14: Fix docstring font-locking, try to clarify various regex names, ELPA Syncer, 2023/09/08
- [nongnu] elpa/clojure-ts-mode 0c4bd2bfce 06/14: Indent example file, ELPA Syncer, 2023/09/08
- [nongnu] elpa/clojure-ts-mode d4e0f1ae44 09/14: Move thing-settings out of the middle of indent-related functions, ELPA Syncer, 2023/09/08
- [nongnu] elpa/clojure-ts-mode 177ac05434 08/14: Indent within docstrings - not working 100%, ELPA Syncer, 2023/09/08
- [nongnu] elpa/clojure-ts-mode 1675f12e26 12/14: Unused argument causing linter to fail, ELPA Syncer, 2023/09/08
- [nongnu] elpa/clojure-ts-mode 881756c8f5 14/14: Remove unused function, ELPA Syncer, 2023/09/08
- [nongnu] elpa/clojure-ts-mode 211dc1452b 11/14: Update README docs to include new configuration options, ELPA Syncer, 2023/09/08