DOCUMENTATION.md

Reactor-C Documentation

Automatically Generated Doc Files

The code in reactor-c is documented with Javadoc-style comments that are automatically processed and deployed when you push updates to the repo. The latest docs can be found here:

• reactor-c docs

Building Doc Files Locally

To clone the repo and build the doc files locally, simply do this:

Prerequisites

• Install doxygen

Build Documentation Files

• Check out this repo and build the docs:
  • git clone git@github.com:lf-lang/reactor-c.git
  • cd reactor-c
  • make docs

View Documentation Files

• Point your browser to the generated HTML page:
  • firefox docs/_build/html/index.html