Skip to content

Commit

Permalink
clean up build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mmoskal committed Nov 9, 2024
1 parent 1180f44 commit 19b57d8
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,16 +54,19 @@ are implemented.
## Building

- [install rust](https://www.rust-lang.org/tools/install); 1.75 or later

If you just need the C or Rust library (`llguidance_parser`),
check the [parser](./parser/README.md) directory.

For Python bindings:

- 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`

This builds the Python bindings for the library and runs the tests
(which mostly live in the Guidance repo - it will clone it).

The Rust crate is called `llguidance_parser`.
For usage see the [README there](./parser/README.md).

## TODO

- [ ] `to_regex_vec()` in lexerspec.rs - non-contextual keywords
Expand Down

0 comments on commit 19b57d8

Please sign in to comment.