Skip to content

Commit

Permalink
Update README.md Documentation
Browse files Browse the repository at this point in the history
How to generate the code documentation with make and which framework is used
  • Loading branch information
franziska-wegner authored Dec 2, 2023
1 parent ac73745 commit 60a5074
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ License|Linux & macOS Build

<h2>Installation</h2>

This is a Cmake project and can be run in any C++ IDE that is on the market. You have to define a certain set of parameters dependent on your system and what you wish to run in general.
This is a Cmake project and can be run in any C++ IDE (Integrated Development Environment) that is on the market and supports CMake. You have to define a certain set of parameters dependent on your system and what you wish to run in general. The following will help you with the initial setup and links to the frameworks that can be linked in addition.

<h3>Required Preinstallations</h3>
Qt (for now)
Expand Down Expand Up @@ -77,7 +77,20 @@ This framework provides a set of unittests that uses the Google Test Framework a

A general recommendation is CLION and Sublimetext. However, Visual Studio and others work fine as well.

<h2>Documentation</h2>

For the purpose of code documentation, the <a href="https://www.doxygen.nl">Doxygen</a> framework is used. It provides a simple and well formed way of code docuemtation for C++. Run

make doc

to compile and generate the repository's documentation. The `DoxyfileConfig.in` can be adapted and supports HTML (see `GENERATE_HTML`), LaTex (see `GENERATE_LATEX`), RTF (see `GENERATE_RTF`), MAN page (see `GENERATE_MAN`), XML (see `GENERATE_XML`), and DOCBOOK (see `GENERATE_DOCBOOK`) output of the documentation. Initially only html and latex is generated. The output directory is under`./documentation` and can be changed at `OUTPUT_DIRECTORY` if necessary.

<h2>Summary</h2>

This repository is based on the PhD thesis <a href="http://dx.doi.org/10.5445/IR/1000120612">"Combinatorial Problems in Energy Networks -- Graph Theoretic Models and Algorithms"</a>. The Git repository of the PhD thesis is available under <a href="https://github.com/franziska-wegner/PhD_Thesis--Combinatorial_Problems_in_Energy_Networks--Graph_Theoretic_Models_and_Algorithms">Combinatorial_Problems_in_Energy_Networks</a>.

<h2>Resources</h2>

https://www.doxygen.nl
https://github.com/franziska-wegner/PhD_Thesis--Combinatorial_Problems_in_Energy_Networks--Graph_Theoretic_Models_and_Algorithms
http://dx.doi.org/10.5445/IR/1000120612

0 comments on commit 60a5074

Please sign in to comment.