Skip to content

Commit 53c37e4

Browse files
committed
Add system requirements to the README
Fixes #1 for now
1 parent dc1d7de commit 53c37e4

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ install it from the marketplace (It's called [Bash IDE][vscode-marketplace]).
2020

2121
## Development guide
2222

23+
**prerequisite:** The extension is using [node-gyp][node-gyp] to build the bash
24+
tree-sitter parser. See node-gyps [system requirements][node-gyp-installation].
25+
2326
Install the dependencies:
2427

2528
npm install
@@ -37,3 +40,5 @@ Launch the extension using `Launch Client` from within vscode.
3740
[tree-sitter]: https://github.com/tree-sitter/tree-sitter
3841
[tree-sitter-bash]: https://github.com/tree-sitter/tree-sitter-bash
3942
[vscode-marketplace]: https://marketplace.visualstudio.com/items?itemName=mads-hartmann.bash-ide-vscode
43+
[node-gyp]: https://github.com/nodejs/node-gyp
44+
[node-gyp-installation]: https://github.com/nodejs/node-gyp#installation

vscode-client/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
Bash language server. Uses [Tree Sitter][tree-sitter] and its
44
[grammar for Bash][tree-sitter-bash].
55

6+
## System Requirements
7+
8+
The extension is using [node-gyp][node-gyp] to build the bash tree-sitter parser
9+
during installation. See node-gyps [system requirements][node-gyp-installation].
10+
611
## Features
712

813
- [x] Jump to declaration
@@ -15,3 +20,5 @@ Bash language server. Uses [Tree Sitter][tree-sitter] and its
1520

1621
[tree-sitter]: https://github.com/tree-sitter/tree-sitter
1722
[tree-sitter-bash]: https://github.com/tree-sitter/tree-sitter-bash
23+
[node-gyp]: https://github.com/nodejs/node-gyp
24+
[node-gyp-installation]: https://github.com/nodejs/node-gyp#installation

0 commit comments

Comments
 (0)