Skip to content

Commit bc2ef54

Browse files
committed
Add more details to README
1 parent 2836285 commit bc2ef54

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,30 @@
11
# OpenQASM Parser
22

3-
- OCaml library for manipulating OpenQASM Abstract Syntax Tree
3+
OCaml library for manipulating [OpenQASM](https://github.com/Qiskit/openqasm) Abstract Syntax Tree
4+
5+
## Requirements
6+
This library requires a recent version of OCaml, `dune` and `menhir`.
7+
8+
## Installation
9+
10+
Use the package manager [opam](https://opam.ocaml.org/) to install OpenQASM parser.
11+
12+
```bash
13+
opam install openQASM
14+
```
15+
16+
Or use the standard `make build` and `make install` commands.
17+
18+
## Usage
19+
20+
To play with the library, run `dune utop` and issue a command such as:
21+
22+
```ocaml
23+
OpenQASM.get_ast "teleport.qasm";;
24+
```
25+
26+
## Contributing
27+
Pull requests are welcome.
28+
29+
## License
30+
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)