Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mmoskal committed Aug 21, 2024
1 parent a604c53 commit da7392b
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,16 @@ on top of a lexer which uses [derivatives of regular expressions](https://github
It's to be used by next-generation [Guidance](https://github.com/guidance-ai/guidance) grammars.
See how it works in [plan.md](./plan.md).

Guidance branch: https://github.com/hudson-ai/guidance/tree/lazy_grammars

This is now available in `main` branch of Guidance.
Guidance PR: https://github.com/guidance-ai/guidance/pull/951

## Building

* [install rust](https://www.rust-lang.org/tools/install); 1.75 or later
* install python 3.9 or later; very likely you'll need a virtual env/conda
* run `./scripts/install-deps.sh`
* to build and after any changes, run `./scripts/test-guidance.sh`

## Guidance implementation notes

- `gen()` now generates a new node, `Gen`
Expand Down

0 comments on commit da7392b

Please sign in to comment.