Skip to content

Commit 39f93d4

Browse files
committed
Improve the setup docs
1 parent e983470 commit 39f93d4

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -144,10 +144,22 @@ setting `clojure-ts-jank-use-cpp-parser` to `nil`.
144144
If you have `git` and a C compiler (`cc`) available on your system's `PATH`,
145145
`clojure-ts-mode` will install the
146146
grammars when you first open a Clojure file and `clojure-ts-ensure-grammars` is
147-
set to `t` (the default).
147+
set to `t` (the default). macOS users can install the required tools like this:
148+
149+
```shell
150+
xcode-select --install
151+
```
152+
153+
Similarly, Debian/Ubuntu users can do something like:
154+
155+
```shell
156+
sudo apt install build-essential
157+
```
158+
159+
This installs GCC, G++, `make`, and other essential development tools.
148160

149161
If `clojure-ts-mode` fails to automatically install the grammar, you have the
150-
option to install it manually, Please, refer to the installation instructions of
162+
option to install it manually. Please, refer to the installation instructions of
151163
each required grammar and make sure you're install the versions expected (see
152164
`clojure-ts-grammar-recipes` for details).
153165

@@ -249,7 +261,7 @@ Note that `clojure-ts-semantic-indent-rules` should be set using the
249261
customization interface or `setopt`; otherwise, it will not be applied
250262
correctly.
251263

252-
#### Project local indentation
264+
#### Project-specific indentation
253265

254266
Custom indentation rules can be set for individual projects. To achieve this,
255267
you need to create a `.dir-locals.el` file in the project root. The content
@@ -261,7 +273,7 @@ should look like:
261273
```
262274

263275
In order to apply directory-local variables to existing buffers, they must be
264-
reverted.
276+
"reverted" (reloaded).
265277

266278
### Vertical alignment
267279

0 commit comments

Comments
 (0)