summaryrefslogtreecommitdiffstats
path: root/sd-plugin
diff options
context:
space:
mode:
authorShahar Ariel <73217928+shahariel@users.noreply.github.com>2021-10-18 14:14:59 +0300
committerGitHub <noreply@github.com>2021-10-18 14:14:59 +0300
commite914f09a076337691e560851c238c67388b581b0 (patch)
treee6fb6ba58d1b40f9c1987f666488694bedacce25 /sd-plugin
parent961c5835d4ddf6d58fd083419753032053d593d5 (diff)
Update README.md
Diffstat (limited to 'sd-plugin')
-rw-r--r--sd-plugin/README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/sd-plugin/README.md b/sd-plugin/README.md
index a020abf7d64..76a0a53d49f 100644
--- a/sd-plugin/README.md
+++ b/sd-plugin/README.md
@@ -6,12 +6,14 @@ 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
+- sd.bnf
+- 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"
+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 you'll need to generate again. The proper way is to delete the "gen" folder and then do a) and b) again.
+
+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.