CSCE 240 Project Documentation

% README

   File:   README.md
   Author: Chris McKinney 

   Date Created: Aug 24 2015
   Date Edited:  Nov 03 2015

Quick Execution

To quickly compile and execute the project:

$ cd <project>
$ ./exec.sh [args...]

To clean up the project to its pre-compilation state:

$ ./clean.sh

Project Structure

<project>/ — The project root directory

clean.sh — Script to clean up the project directory

doxygen.config — Configuration for doxygen

exec.sh — Script to compile and execute the project

html/ — Directory for doxygen documentation

index.html — The main page for the documentation

include/ — Directory for header files

Makefile — The makefile for the project

README.md — This file

src/ — Directory for source files

obj/ — Directory for object files during building

.ycm_extra_conf.py — Ignore. Configuration for YouCompleteMe

Compiling

To compile to an executable (main):

$ cd <project>
$ make

To clean up the executable and object files:

$ make clean

Executing

To execute the program after compiling:

$ cd <project>
$ ./main [args...]

Documentation

To compile the documentation:

$ cd <project>
$ doxygen doxygen.config

To clean up the documentation:

$ rm -R html/*