aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 1a10858e9fc396c4df38fba66a36d1194fe2d013 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# okaml-rs

okaml-rs is a Rust library for parsing [okaml](github.com/lang-okaml).

## Installation

Use the package manager [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) to install foobar.

```bash
cargo add okaml
```

## Usage

```rust
use okaml;

fn main() {
    let file_path = "../example/syntax.okml";
    let parsed_tree:Vec<Okml> = Okml::read_from_file(file_path);
    println!("{:?}", parsed_ast);
}
```

## Contributing

Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[MIT](https://choosealicense.com/licenses/mit/)