C++ Starter Algo

[idraper]

This is a project for a C++ starter algo.

It uses CMake (see README for building) and has been tested on Visual Studio 2017, Ubuntu 16 and 18, and macOS Mojave.

The three contributors for this project were myself (@isaac), Ryan Draves (@Ryan_Draves), and paprikadobi (@Paprikadobi).

[Zlass]

Hey awesome PR, if you guys could remove the auto-generated docs and include some instructions on how you built them we'll be able to host them for you.

[idraper]

I removed the documentation and put the explanation of how to generate the documentation in the main README. I will also copy it here for convenience:

Documentation

Documentation for this starter-kit can be generated using doxygen. The general steps to do so and explanation for their accepted style can be found on their website. However, the steps that we took were:

1. Install doxygen (found on their website).

2. Create folder to generate the documentation (mkdir dox) and go to it (cd dox).

3. Generate the config for doxygen (doxygen -g dox-config).

4. Modify the following options found in the dox-config file:

   • EXTRACT_ALL = YES
   • INPUT = ../ (or the path to the c++-algo code)
   • RECURSIVE = YES
   • JAVADOC_AUTOBRIEF = YES
   • EXCLUDE_PATTERNS = */build/* + */json11/*
   • USE_MDFILE_AS_MAINPAGE = ../README.md (or path to this README)
   • STRIP_FROM_PATH (set it equal to the path up to and not including the C1GamesStarterKit) (eg C:/Users/.../)

5. Run doxygen (doxygen dox-config).

You can modify the output style further by specifying an html header/footer and css style (see doxygen documentation.

[JBX2060]

Someone merge this when?

[Nathan13888]

I'd use this once this gets merged :)