Skip to content

B. Directory Structure of Shaka Scheme

Kayla-Kwock edited this page Feb 15, 2018 · 3 revisions

CMakeLists.txt - CMake configuration file

  • Integrated with CLion
    • Makes the IDE experience easy and relatively painless compared to Makefiles
    • No include/ folder
      • .cpp and .hpp are mixed together
      • Interface currently incomplete

tst/

Holds all the unit-tests and integration-tests

  • unit-tests are denoted by unit-______.cpp
  • integration-tests are denoted by integ-______.cpp

This directory mirrors the src/ directory structure

If a tst subfolder has any subfolders, it will have stub CMakeLists.txt to include them.

dep/

Short for Dependency

  • GoogleTest is our only current Dependency
  • These items are compiled first during the build process

config-cmake/

Sets up the CMake configuration for dependencies

This directory mirrors the dep/ directory structure

Files in this directory have multiple purposes including

  • Associating library variable names with directory paths

docs/

Holds files created by DOxygen

These files document how to use Shaka Scheme

Clone this wiki locally