Install dependencies

opam install . --deps-only --with-test

Build pirc

dune build

Run tests

dune test

Build and execute

dune exec pirc -- [options] <file>

Then pirc will parse the file and dump the ASTs to the current terminal (in pretty-printed format by default).

Options

• -<pprint|json|dot>: Dump the AST in pretty-printed or JSON format, or generate a DOT file for AST visualization.

• use - to read the source code from stdin. E.g.:

cat examples/1.pir | dune exec pirc -- -

• use -o <file> to write the output to a file. E.g.:

dune exec pirc -- -json examples/1.pir -o out

Documentation

make docs

Then open pdf files in docs directory.

Contribute

• Git Guides

  • Name your branch <your-names>/<feature>

  • Make your PR small and focused

• OCaml Programming Guidelines

  • You can format your code using dune fmt

  • Avoid using open

• You can enable repo-wide githooks to make sure your code is formatted and can build

  git config core.hooksPath .githooks