Skip to content

Commit 1fa9ced

Browse files
committed
Improve the installation instructions
1 parent 9bca1c3 commit 1fa9ced

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

README.md

+19-8
Original file line numberDiff line numberDiff line change
@@ -51,23 +51,29 @@ Those will be addressed over the time, as more and more people use `clojure-ts-m
5151

5252
## Installation
5353

54-
### Emacs 29
55-
56-
This package requires Emacs 29 built with tree-sitter support from the [emacs-29 branch](https://git.savannah.gnu.org/cgit/emacs.git/log/?h=emacs-29).
57-
58-
If you decide to build Emacs from source there's some useful information on this in the Emacs repository:
59-
60-
- [Emacs tree-sitter starter-guide](https://git.savannah.gnu.org/cgit/emacs.git/tree/admin/notes/tree-sitter/starter-guide?h=emacs-29)
61-
- [Emacs install instructions](https://git.savannah.gnu.org/cgit/emacs.git/tree/INSTALL.REPO).
54+
### Requirements
6255

56+
For `clojure-ts-mode` to work, you need Emacs 29+ built with TreeSitter support.
6357
To check if your Emacs supports tree sitter run the following (e.g. by using `M-:`):
6458

6559
``` emacs-lisp
6660
(treesit-available-p)
6761
```
6862

63+
Additionally, you'll need to have Git and some C compiler (`cc`) installed and available
64+
in your `$PATH` (or Emacs's `exec-path`), for `clojure-ts-mode` to be able to install the required
65+
TreeSitter grammars automatically.
66+
6967
### Install clojure-ts-mode
7068

69+
> [!NOTE]
70+
>
71+
> That's the recommended way to install `clojure-ts-mode`.
72+
73+
If you have `git` and a C compiler (`cc`) available on your system's `PATH`,
74+
`clojure-ts-mode` will install the
75+
grammars
76+
7177
clojure-ts-mode is available on [MElPA](https://melpa.org/#/clojure-ts-mode) and
7278
[NonGNU ELPA](https://elpa.nongnu.org/nongnu/clojure-ts-mode.html).
7379
It can be installed with
@@ -102,6 +108,11 @@ Once installed, evaluate clojure-ts-mode.el and you should be ready to go.
102108

103109
### Install tree-sitter grammars
104110

111+
> [!NOTE]
112+
>
113+
> `clojure-ts-mode` install the required grammars automatically, so for most
114+
> people no manual actions will be required.
115+
105116
`clojure-ts-mode` makes use of two TreeSitter grammars to work properly:
106117

107118
- The Clojure grammar, mentioned earlier

0 commit comments

Comments
 (0)