branch: elpa/blueprint-ts-mode
commit 9318afb190b7886f754be4fcaab70d5659bd3a5a
Author: Huan Nguyen <[email protected]>
Commit: Huan Nguyen <[email protected]>
Added readme.
---
README.org | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/README.org b/README.org
new file mode 100644
index 0000000000..dba87e023d
--- /dev/null
+++ b/README.org
@@ -0,0 +1,15 @@
+* blueprint-ts-mode
+Major mode for Blueprint
([[https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/]]) based on
Treesitter.
+
+* Installation
+You need Emacs version >= 29. Your Emacs also needs to be compiled with
Treesitter support (~--with-tree-sitter~) which you can check with the variable
~system-configuration-options~.
+
+Install ~blueprint-ts-mode~ from NONGNU ELPA. ~package-install
blueprint-ts-mode~.
+
+* Features
+- Font Lock
+- Indentation
+- Eglot integration
+- Treesitter based navigation
+
+ These features still need improvement. Feedback and contributions are
welcome!
