Skip to content

Commit a8a3215

Browse files
committed
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.
1 parent 1675f12 commit a8a3215

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ highlighting), indentation, and navigation support for the
1414

1515
## Configuration
1616

17-
To see a list of available configuration options do M-x customize-group RET clojure-ts.
17+
To see a list of available configuration options do `M-x customize-group <RET> clojure-ts`.
1818

1919
Most configuration changes will require reverting any active clojure-ts-mode buffers.
2020

@@ -108,6 +108,12 @@ Once installed, evaluate clojure-ts-mode.el and you should be ready to go.
108108

109109
### Install libtree-sitter-clojure shared library
110110

111+
The tree-sitter clojure shared library must be available to Emacs.
112+
If you have `git` and a C compiler (`cc`) available on your system's `PATH`, **then these steps should not be necessary**.
113+
clojure-ts-mode will install the grammar when you first open a Clojure file.
114+
115+
If clojure-ts-mode fails to automatically install the grammar, you have the option to install it manually.
116+
111117
#### From your OS
112118

113119
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
116122
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.
117123
If this happens you should install the grammar manually with `M-x treesit-install-language-grammar <RET> clojure`.
118124

119-
#### Manually
120-
121-
The tree-sitter clojure shared library must be available to Emacs.
122-
If you have `git` and a C compiler (`cc`) available on your system's `PATH`, **then these steps should not be necessary**.
123-
clojure-ts-mode will install the grammar when you first open a Clojure file.
124-
125-
If clojure-ts-mode fails to automatically install the grammar, you have the option to install it manually.
126-
127-
The first way is to run `M-x treesit-install-language-grammar <RET> clojure` in Emacs.
128-
This is what clojure-ts-mode attempts to do when a suitable grammar is not found.
125+
#### Compile From Source
129126

130-
If that fails, you can attempt to download and compile manually.
127+
If all else fails, you can attempt to download and compile manually.
131128
All you need is `git` and a C compiler (GCC works well).
132129

133130
To start, clone [tree-sitter-clojure](https://github.com/sogaiu/tree-sitter-clojure).

0 commit comments

Comments
 (0)