summaryrefslogtreecommitdiff
path: root/scanner/README.md
diff options
context:
space:
mode:
authorMarc Vertes <mvertes@free.fr>2023-08-24 11:00:28 +0200
committerMarc Vertes <mvertes@free.fr>2023-08-24 11:00:28 +0200
commitec8eb9defc7cd68fcd3afa0058773bcbc33ecd63 (patch)
treeb8742524f18e6703006c99c1909e20b5c4cd586c /scanner/README.md
parent8080afb5a9e38116646d69155365fb6bd09ea40c (diff)
doc: add diagrams to scanner and parser readmes
Diffstat (limited to 'scanner/README.md')
-rw-r--r--scanner/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/scanner/README.md b/scanner/README.md
index c131a9f..a51d8a7 100644
--- a/scanner/README.md
+++ b/scanner/README.md
@@ -2,6 +2,18 @@
A scanner takes a string in input and returns an array of tokens.
+```mermaid
+graph LR
+s[ ] --> |source| a(scanner)
+--> |tokens| b(parser)
+--> |AST| c[ ]
+subgraph scanner
+ a
+end
+style s height:0px;
+style c height:0px;
+```
+
Tokens can be of the following kinds:
- identifier
- number