User Tools


Source repository

This article explain the content of the source code package

The repository is available on GitHub

Directory listing

  • build : build directory for CMake project. Contain some resources for automated testing.
  • doc : documentation resources
  • doxygen : doxygen files and generated html of the API documentation
  • example : sample program/tutorials
  • include : library headers
  • lib : the build library directory
  • logo : Logo of the Annwvyn engine
  • obj : object files
  • pch : pre-compilled headers source code. This is for speeding up the build on Visual Studio
  • setup : InnoSetup generation scripts
  • src : source code
  • template : a project directory that you can copy to deploy your own Annwvyn project
  • tests : Catch powered automated tests. For Annwvyn development
  • utils : misc. utilities

Other files :

  • .clang-format : file for configuring a style for clang format for automatic formating
  • .gitattributes : instructions for GitHub about the content of the repository
  • .gitignore : files to be, by default, ignored by Git
  • Annwvyn.cppcheck : cppcheck project
  • CMakeLists.txt : CMake main file.
  • DEPEDENCIES : file explaining what depedencies needs to be installed to build the engine
  • LICENSE : MIT license agreement
  • README.md : Markdown formated description of the project
  • TODO.md : markdown formated simple todo list
  • versioning : file explaining the versioning scheme used for the project.