diff options
| author | Shahar Ariel <73217928+shahariel@users.noreply.github.com> | 2021-10-18 14:12:52 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-18 14:12:52 +0300 |
| commit | 961c5835d4ddf6d58fd083419753032053d593d5 (patch) | |
| tree | 81a6053d09e58bb289ff171d409d3cbe54130c42 /sd-plugin | |
| parent | 9f21ec2d35510f7bb046405cf2f6d40006e31333 (diff) | |
Update README.md
Diffstat (limited to 'sd-plugin')
| -rw-r--r-- | sd-plugin/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/sd-plugin/README.md b/sd-plugin/README.md index 8b137891791..a020abf7d64 100644 --- a/sd-plugin/README.md +++ b/sd-plugin/README.md @@ -1 +1,17 @@ +This directory holds the code for an IntteliJ plugin for reading SD files. + +NOTE: This is the source code, not the plugin itself. In order to be able to use the plugin you'll need to download it from JetBrains Marketplace or create a zip file and load it to IntelliJ (details later). + +Before cloning, you should download Gradle and create a Gradle project. +You should also download Grammar-Kit plugin from the Marketplace. + +The grammar is defined in 2 files: +1. sd.bnf +2. sd.flex + +After cloning, you should: + a) Right-click the sd.bnf file and press "Generate Parser Code" + b) Right-click the sd.flex file and press "Run JFlex Generator" +Now you should have a "gen" folder next to the "java" folder, and it contains all the parser and lexer code. +Improtant note! After any change in one of this 2 files you'll need to generate again. The proper way is to delete the "gen" folder and then do a) and b) again. |