diff options
Diffstat (limited to 'sd-plugin/README.md')
| -rw-r--r-- | sd-plugin/README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/sd-plugin/README.md b/sd-plugin/README.md new file mode 100644 index 00000000000..76a0a53d49f --- /dev/null +++ b/sd-plugin/README.md @@ -0,0 +1,19 @@ +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: +- sd.bnf +- sd.flex + +After cloning, you should: +1. Right-click the sd.bnf file and press "Generate Parser Code" +2. 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 (bnf, flex) you'll need to generate again. The proper way is to delete the "gen" folder and then do 1-2 again. + |