Commit 994a0b06 authored by Hans-Peter Deifel's avatar Hans-Peter Deifel 🐢
Browse files

README: Add instructions for building API documentation

parent 7c694a3d
......@@ -15,3 +15,12 @@ use:
Where `FILENAME` is a yaml file describing the input. There is an
example in `examples/example.yaml`.
## API documentation
The documentation for the internal API can be built and opened in the
default browser with:
stack haddock --open ma
This can help to understand the code structure.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment