summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorColin Okay <cbeok@protonmail.com>2020-04-25 21:00:12 -0500
committerColin Okay <cbeok@protonmail.com>2020-04-25 21:00:12 -0500
commit6a046725d18c93006bbb5a1276b6717eb84f11ec (patch)
tree8963d6a76947d7745bafa73b4a4eebd380232060
parenta4c3e0cacf062cbed23e4ddd1113d6de13450376 (diff)
readme includes link to tutorial
-rw-r--r--README.org18
1 files changed, 7 insertions, 11 deletions
diff --git a/README.org b/README.org
index 5cafe49..d2752f4 100644
--- a/README.org
+++ b/README.org
@@ -1,18 +1,14 @@
* parzival
- The quest of =parzival= is to make it fun and easy to build parsers that
- consume streams and return common lisp values. E.g. A [[https://github.com/thegoofist/parzival/blob/master/examples/json-parzival.lisp][JSON]] parser or an HTTP
- parser could both be written extremely succinctly in parzival.
+ The quest of =parzival= is to make it fun and easy to build parsers
+ that consume streams and return common lisp values. E.g. A [[https://github.com/cbeo/parzival/blob/master/examples/Tutorial.org][JSON]]
+ parser or can be written reasonbly succinctly in parzival.
- In =parzival=, a *parser is a function* that accepts a *stream* and returns
- three values:
-
- 1. A *parse result*, which is any value.
- 2. A *success indicator*, which is =t= or =nil=.
- 3. The possibly modified *stream* that was initially passed in.
+ Check out the [[https://github.com/cbeo/parzival/blob/master/examples/Tutorial.org][Tutorial]] for a detailed introduction.
-** A Neat Example
+
+** A Neat / Dumb Example
What follows is a quick example of using =parzival= to build a parser for
simple arithmetic expressions. But first, you should be aware of two
@@ -74,7 +70,7 @@ In the last example the string ="foozball"= does not represent a real
number, and hence, the parse fails. You can examine the third return
value to see where in the input stream the parse failed.
-** An Extended Silly Example
+** An Extended Silly / Dumber Example
The code for this example is a little long winded, so for the
impatient I present below the grand payoff.