add build instructions

LdBeth · Dec 31, 2023 · f9f2030 · f9f2030
1 parent 33324b3
commit f9f2030
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-TREE_CLI := $(HOME)/.cargo/bin/tree-sitter
+TREE_CLI := tree-sitter
 EXAMPLE := examples/test.rnc
 LIBEXT := dylib
 TARGET := libtree-sitter-rnc.$(LIBEXT)

diff --git a/README.md b/README.md
@@ -4,6 +4,19 @@ Based on https://relaxng.org/compact.html with
 the attempt to make the grammar more readable when
 avoid ambiguity.
 
+# Installation
+
+This requires the Emacs 29 builtin `treesit.el` support.
+Compile and install the `libtree-sitter-rnc.$(LIBEXT)`
+to `treesit` search path, e.g. `~/.emacs.d/tree-sitter/`.
+
+```
+$ cc -fPIC -c -Isrc src/parser.c
+$ cc -fPIC -shared parser.o -o libtree-sitter-rnc.so
+```
+
+Copy `emacs/rnc-ts-mode.el` to Emacs load path.
+
 # Copying
 
 This program is free software: you can redistribute it and/or modify