Skip to content

benvenutti/core8

Repository files navigation

core8 Build Status Build status codecov License: MIT

core8 is a CHIP8 emulator that offers a Qt GUI to run CHIP8 binaries.

Cloning

Make sure to clone the repository with its submodules. One way to do this is as follows:

git clone --recurse-submodules https://github.com/benvenutti/core8.git

Building core8

The building process of core8 is managed by CMake scripts. The following list enumerates all dependencies and requirements to build the project:

  • C++14 compiler
  • CMake 3.8
  • Qt 5.10
  • Libboost 1.54
  • Catch 2

Configure & Compile

It is recommended to configure the build out-of-source, so that the source tree and the build tree are separated. The most usual way to achieve this is to create a build directory inside the source directory:

core8$ mkdir build && cd build
core8/build$ cmake ..
core8/build$ cmake --build .

Running tests

To run the available tests after a successful build, you need to execute the test target. One way of doing this is using ctest the build folder. Here is an example:

core8/build$ ctest .
Running tests...
Test project /home/diogo/projects/core8/build
    Start 1: ModelTestSuite
1/1 Test #1: ModelTestSuite ...................   Passed    0.04 sec

100% tests passed, 0 tests failed out of 1

Total Test time (real) =   0.26 sec