From cb40392554ba36e53a0210603dee3f453ce70795 Mon Sep 17 00:00:00 2001
From: Kirill Andreev <hindmost.one@gmail.com>
Date: Thu, 30 Apr 2020 14:49:26 +0400
Subject: [PATCH] Add README.md with install/run instructions

---
 tools/lsp/README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 tools/lsp/README.md

diff --git a/tools/lsp/README.md b/tools/lsp/README.md
new file mode 100644
index 000000000..c9a4260b1
--- /dev/null
+++ b/tools/lsp/README.md
@@ -0,0 +1,27 @@
+
+To compile and run, the following tools are needed:
+
+1) tree-sitter-clr (the Node.js one was usied during development)
+2) optionally, nix package manager
+3) haskell-stack
+
+First, you need to generate the `parser.c`.
+For that, do
+
+```
+cd tools/lsp/pascaligo
+tree-sitter generate
+```
+
+Then
+```
+cd ../squirrel
+stack install
+```
+
+To use the executable, do
+```
+squirrel <filename>.ligo
+```
+
+At this stage of development, it first prints the dump of tree-sitter parse tree, then its attempts to build actual parse tree.
\ No newline at end of file