Skip to content
Vinícius do Carmo Melício edited this page Mar 10, 2023 · 2 revisions

The README.md file is an essential part of the project's documentation, and it provides an overview of the project's purpose, features, and requirements. It should be the first point of reference for anyone interested in understanding the project, and it should be read before attempting to build or use the code.

The code structure of this project follows a common organization pattern for C++ projects, where the source code files are separated into different directories based on their type or purpose. The project has four main directories: bin, include, src, and tpl, along with a Makefile and a README.md file.

The bin directory is used to store the compiled object files (.o) and dependency files (.d) generated by the Makefile during the compilation process.

The include directory contains all the header files (.hpp) required for the project, including assertion.hpp, error.hpp, and matrix.hpp.

The src directory contains all the source code files (.cpp) for the project, including Debug.cpp, assertion.cpp, and error.cpp.

Finally, the tpl directory contains template files (.tpp) used for defining template functions from the header files.

For each class in the project, there is a dedicated wiki page that provides comprehensive information, including preprocessor functions, constructors, and relevant details, along with practical examples of usage.

Clone this wiki locally