branch: elpa/clojure-ts-mode
commit f3697d0cb2eb7721780750ef5272338944298f70
Author: Bozhidar Batsov <bozhi...@batsov.dev>
Commit: Bozhidar Batsov <bozhi...@batsov.dev>
Tweak the README's formatting a bit
You shouldn't have multiple H1 headings in a single document.
---
README.md | 22 +++++++++++++---------
1 file changed, 13 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 84e8dea138..337e5e1a2d 100644
--- a/README.md
+++ b/README.md
@@ -3,14 +3,14 @@
# Clojure Tree-Sitter Mode
`clojure-ts-mode` is an Emacs major mode that provides font-lock (syntax
-highlighting),indentation, and navigation support for the
+highlighting), indentation, and navigation support for the
[Clojure(Script) programming language](http://clojure.org), powered by the
[tree-sitter-clojure](https://github.com/sogaiu/tree-sitter-clojure)
[tree-sitter](https://tree-sitter.github.io/tree-sitter/) grammar.
-# Installation
+## Installation
-## Emacs 29
+### Emacs 29
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).
As of right now, users must install Emacs from source with tree-sitter
installed on their system.
@@ -18,7 +18,7 @@ More information on this can be found in the Emacs repository:
- [Emacs tree-sitter
starter-guide](https://git.savannah.gnu.org/cgit/emacs.git/tree/admin/notes/tree-sitter/starter-guide?h=emacs-29)
- [Emacs install
instructions](https://git.savannah.gnu.org/cgit/emacs.git/tree/INSTALL.REPO).
-## Install libtree-sitter-clojure shared library
+### Install libtree-sitter-clojure shared library
The tree-sitter clojure shared library must be available to Emacs.
clojure-ts-mode will not automatically install this (yet).
@@ -29,24 +29,28 @@ To start, clone
[tree-sitter-clojure](https://github.com/dannyfreeman/tree-sitte
Then run the following code (depending on your OS) from the
tree-sitter-clojure repository on your machine.
(A C compiler like GCC is required)
-### Linux
+#### Linux
+
```bash
mkdir -p dist
cc -c -I./src src/parser.c -o "parser.o"
cc -fPIC -shared src/parser.o -o "dist/libtree-sitter-clojure.so"
```
-### OS X
+#### macOS
+
```bash
mkdir -p dist
cc -c -I./src src/parser.c -o "parser.o"
cc -fPIC -shared src/parser.o -o "dist/libtree-sitter-clojure.dylib"
```
-### Windows
+#### Windows
+
I don't know how to do this on Windows. Patches welcome!
-### Finally, in emacs
+#### Finally, in emacs
+
Then tell Emacs where to find the shared library by adding something like this
to your init file
```emacs-lisp
@@ -56,7 +60,7 @@ Then tell Emacs where to find the shared library by adding
something like this t
OR you can move the `libtree-sitter-clojure.so`/`libtree-sitter-clojure.dylib`
to a directory named `tree-sitter`
under your `user-emacs-directory`.
-## Install clojure-ts-mode
+### Install clojure-ts-mode
This package is not yet avaialble through package.el.
You can install it by cloning the repository and adding it to your load path.
