Menu

Tree [0152ea] master /
 History

HTTPS access


File Date Author Commit
 img 2021-02-04 mill-j mill-j [0152ea] More Updates
 src 2021-02-04 mill-j mill-j [c5fc07] Structure order updates
 Doxyfile 2020-11-27 mill-j mill-j [41b73b] Initial commit
 HatchKeeper.dox 2021-02-04 mill-j mill-j [0152ea] More Updates
 HatchKeeper_Icon.bmp 2020-11-27 mill-j mill-j [41b73b] Initial commit
 README.md 2021-02-04 mill-j mill-j [e268fd] Update Readme
 TODO 2020-11-27 mill-j mill-j [41b73b] Initial commit

Read Me

HatchKeeper User Documetation

You will need to install Doxygen:

sudo apt-get install doxygen doxygen-latex

Cd into the root of the source and run:

doxygen ./Doxyfile

This should add two folders. One named html and the other named latex.
Open html/index.html in your web browser. If you want a pdf you will
need to install:

sudo apt-get install texlive-latex-base texlive-latex-extra texlive-latex-recommended

Cd into the latex folder and run:

make

The result will be called refman.pdf

License

Copyright (C) 2020 - 2021 The HatchKeeper Team
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
published by the Free Software Foundation;
A copy of the license can be found at http://www.gnu.org/licenses/fdl-1.3.txt.