Renderer/README.md
austin a34dc4a4dc
All checks were successful
studiorailgun/Renderer/pipeline/head This commit looks good
cleaning up top level folder
2024-11-23 14:49:57 -05:00

1.2 KiB

Storm Engine

A multiplayer-focused game engine

Building

Windows

  1. Install
  1. From choco install
  1. Run build.sh

The build will be in <Project Directory>/build

Alternate Build Profiles

Several build profiles are defined in maven to support different functions

  • fast - Only runs the fast unit tests
  • integration - Runs the integration tests
  • integrationDebug - Runs the integration tests with the memory-debug jar linked

Documentation

Building

The documentation uses Doxygen to build.

On windows, it's recommended to use Doxywizard to build the documentation.

To build

  • Open the file <Project Directory>/docs/Doxyfile
  • Navigate to the Run tab
  • Click Run doxygen
  • Click Show HTML output