branch: externals/bicep-ts-mode
commit 34939118c382b58ea38c88318ffe7c7cffe5e110
Author: Jostein Kjønigsen <jost...@kjonigsen.net>
Commit: Jostein Kjønigsen <jost...@kjonigsen.net>
Provide more detailed installation instructions.
---
README.md | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
diff --git a/README.md b/README.md
index 6cc1beaa77..73c5506fcd 100644
--- a/README.md
+++ b/README.md
@@ -21,3 +21,28 @@ prerequisites:
- GNU Emacs built with tree-sitter support enabled
- [Bicep language grammar for
tree-sitter](https://github.com/amaanq/tree-sitter-bicep)
+## Installation
+
+Right now neither the tree-sitter grammar, nor the major-mode is
+published or distributed in any official or semi-official
+package-manager, so you will have to install both manually.
+
+1. Verify Emacs has tree-sitter support enabled. In `C-h v
+ system-configuration-features` look for `TREE_SITTER`.
+2. Install the tree-sitter grammar `M-x
+ treesit-install-language-grammar`, and provide `bicep` as
+ name and `https://github.com/amaanq/tree-sitter-bicep` as
+ source repo. Use defaults for everything else.
+3. Clone the repo somewhere locally and load it from there. The
+ following use-package statement might also work:
+
+```lisp
+(use-package structurizr-ts-mode
+ :ensure t
+ :vc ( :url "https://github.com/josteink/bicep-ts-mode";
+ :rev :newest))
+```
+
+If you have any issues or corrections, feel free to provide a PR to
+help others :)
+
