added readme

This commit is contained in:
Tom
2018-06-12 19:42:56 +02:00
parent 2225706356
commit a0c6f09c8b

26
README.md Normal file
View File

@@ -0,0 +1,26 @@
## Grammar Syntax
### Example
$FOO -> /foo
$FOO -> /foo$FOO
$FOO -> $BAR
$BAR -> /bar
$BAR -> $BAR
### Nonterminals
A Nonterminal starts with a leading `$`. The nonterminal `FOO` would be written as:
$FOO
### Terminals
A Terminals starts with a leading `/`. The terminal `bar` would be written as:
/bar
Note that `/ab` differs from `/a/b`. The string `/ab` resolves to the terminal `ab`,
whereas `/a/b` resolves to the terminals `a` and `b`