aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2021-08-01 21:38:20 -0700
committerBruce Hill <bruce@bruce-hill.com>2021-08-01 21:38:20 -0700
commit07497c020b53bb95ec0d74fa1672c3d74f5ce945 (patch)
tree8baeaa5e44ac47df578351cf455920d04ccf01d9 /README.md
parent41bd2ce6fa1da19c645fc6f7b4ce171235dac1f2 (diff)
Added code layout
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4d4445a..ea1fb12 100644
--- a/README.md
+++ b/README.md
@@ -129,6 +129,22 @@ Testing for these grammar files (other than `builtins`) is iffy at this point,
so use at your own risk! These grammar files are only approximations of syntax.
+## Code Layout
+
+File | Description
+----------------|-----------------------------------------------------
+[bp.c] | The main program.
+[definitions.c] | Defining pattern rules.
+[explain.c] | Printing a visual explanation of a match.
+[files.c] | Loading files and match memoization.
+[json.c] | JSON output of matches.
+[match.c] | Pattern matching code (match a pattern against an input string).
+[pattern.c] | Pattern loading code (build a pattern out of an input string).
+[print.c] | Print pattern match results.
+[utf8.c] | UTF-8 helper code.
+[utils.c] | Miscellaneous helper functions.
+
+
## Performance
Currently, `bp` is super slow compared to hyper-optimized regex tools like