From 51313c4773f0af62121b2192ff0cca9560b7ab44 Mon Sep 17 00:00:00 2001 From: Bruce Hill Date: Sun, 17 Jan 2021 19:42:11 -0800 Subject: Adding more language grammars --- grammars/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 grammars/README.md (limited to 'grammars/README.md') diff --git a/grammars/README.md b/grammars/README.md new file mode 100644 index 0000000..7fa486f --- /dev/null +++ b/grammars/README.md @@ -0,0 +1,14 @@ +# BP Grammars + +The files in this directory are predefined grammars for different languages and +contexts. They are intended to be used for common search patterns, and **not** +intended to be complete PEG definitions of language grammars, other than +[bp.bp](./bp.bp), which is included for stress-testing purposes, as well as a +showcase of some BP features. + +## Adding Grammars + +If you want to add your own grammar, the easiest way to do so is to create a +`.bp` file in `~/.config/bp/`. The syntax for grammar files is fully and +formally defined in [bp.bp](./bp.bp), but in short, it's a list of +whitespace-separated rule definitions of the form `id __ ":" __ pattern`. -- cgit v1.2.3