Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ShinySyntax authored Jan 15, 2025
1 parent 9f7032a commit 79c58df
Showing 1 changed file with 0 additions and 10 deletions.
10 changes: 0 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,28 @@
# mo-parsec

A Parsec based parser combinator library for Motoko.

This is a minimal parsec implementation based directly on a port, from OCaml, of
[Opal](0), which is itself derived from Haskell's influential [Parsec](1) library.

The library and example was implemented primarily to exercise Motoko new type argument inference, but may be of more general use.

* [src](src) contains the [`Parsec`](src/Parsec.mo) library.
* [test](test) contains a sample lambda calculus lexer and parser that you can run with wasmtime.

## API Documentation

API documentation for this library can be found at https://crusso.github.io/mo-parsec/.


## Testing

```bash
make test
```

## Example

```bash
make example
```

## Documentation

There is currently no documentation, but see
Opal's [README](https://github.com/pyrocat101/opal/README.md) for a good overview of the available combinators, whose names
and types are largely preserved (modulo naming conventions and uncurrying).
Expand All @@ -50,17 +44,13 @@ take Motoko immutable arrays instead (e.g. `choice`).


## Disclaimer

The library is not well-tested, use at your own risk.

## References & Credits

[0] https://github.com/pyrocat101/opal

[1] https://www.microsoft.com/en-us/research/wp-content/uploads/2016/02/parsec-paper-letter.pdf

Thanks to Christoph Hegemann for the lambda calculus sample and feedback.

## API

```swift
Expand Down

0 comments on commit 79c58df

Please sign in to comment.