Skip to content
Chandler Haukap edited this page Jan 31, 2020 · 3 revisions

This wiki is intended for end users of the program. If you are interested in developing STEPWAT2 you can generate our API-level Doxygen documentation by cloning the repository and completing the following steps:

For Mac Users

  • Install Doxygen using brew:
brew install doxygen
  • Navigate to the STEPWAT2 directory you cloned.
  • Use the make command to generate the documentation:
make documentation
  • The make command should automatically open the documentation home page in your default browser. If you need to open it manually issue this command from the STEPWAT2 directory:
open Documentation/html/index.html

For Linux Users

  • Install Doxygen:
sudo apt-get install doxygen
  • Navigate to the STEPWAT2 directory you cloned.
  • Use the make command to generate the documentation:
make documentation
  • The make command should automatically open the documentation home page in your default browser. If you need to open it manually issue this command from the STEPWAT2 directory:
xdg-open Documentation/html/index.html