Arcade Documentation

Arcade Interface

<a href="https://github.com/MisterPeModder/Arcade-Interface"><img src="https://img.shields.io/github/license/MisterPeModder/Arcade-Interface" alt="License"/></a>

Building

Command Line (via CMake)

Required tools:

• CMake 3.17 (minimum)

on Linux:

# Create the build directory
mkdir build && cd build 
 
# Configure the project
cmake .. -G 'Unix Makefiles' -DCMAKE_BUILD_TYPE=Release
 
# Build the executable and libraries
cmake --build .
 
# Return to previous directory
cd -

Documentation

The documatation is available online.

Local Docs

Required tools:

• Doxygen

on Linux:

# Run at the root of the project
doxygen
 
# Open the genrated pages
xdg-open doc/generated/html/index.html