Skip to content

Commit 6c74b88

Browse files
committed
Update setup steps for contributing
1 parent 2b074bc commit 6c74b88

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

contributing.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@
44
## Setup
55

66
1. Fork this repo
7-
2. Install Java >= 11
8-
3. Install NPM
7+
2. Install [Java](https://www.oracle.com/au/java/technologies/downloads/) >= 11
8+
3. Install [NPM](https://github.com/coreybutler/nvm-windows)
99
4. `npm install` to install dependencies.
1010
5. `npm run textMate` first time and every time grammar is changed.
1111
6. `npm run antlr4ng` first time and every time grammar is changed.
12+
7. Create a `.\sample` directory as a default workspace for client debugging (or update .\\.vscode\\launch.json as preferred).
1213
7. (Optional) Install [ANTLR4 grammar syntax support](https://marketplace.visualstudio.com/items?itemName=mike-lischke.vscode-antlr4) VSCode extension.
14+
Note: to debug a grammar, you'll first need to activate the extension by opening one of the *.g4 files.
1315

1416
To contribute, you'll need to [create a pull request from a fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
1517
**Signed commits are turned on for this repo.**

0 commit comments

Comments
 (0)