-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
67 lines (56 loc) · 2.5 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
Board Games
(c) 2011 Thaddeus Diamond
Yale University
About This Project
==================
My project seeks to provide a modularized framework for developing games that
share several common structures. Obviously, the scope of this project must be
appropriately narrow in scope, so I have chosen to limit this to two-dimensional
grid-based games such as Tic-Tac-Toe and Gomoku. Game developers then
can merely contribute a tailored game board to the GameBuilder and modify the
configuration file in order to notify the application that a new game is
available to be played.
The purpose of this project is to become acquainted with the development of a
basic platform using big-scale software design patterns and real-world
development tools. These tools are essential for allowing a team of several
developers to work on a project collaboratively at the same time.
Directory Structure
===================
src - All source code for development branch
ext - External libraries required to run tests and conform style
doc - All documentation generated by doxygen
doc/html - [Not in main git branch] Automatically generated HTML from doxygen
bin - [Generated by Makefile] All executables created by project
obj - [Generated by Makefile] All object files (.o) created by project
logs - [Generated by Makefile] Structured directory for tests and
executables to write out to
Testing
=======
This project uses the Google Unit Testing (http://code.google.com/p/googletest/)
framework for all tests. These tests are housed in the src/Tests directory
and can be run from within the src directory using either:
$ make Test # Makes all tests
or:
$ make [DirectoryName]Test # Makes only tests for a specific directory
Contact
=======
Thaddeus Diamond, Project Lead - [email protected]
Professor Michael Fischer, Teacher - [email protected]
License
=======
This software is licensed under the MIT License. Please see "LICENSE".
Prerequisites
=============
- GNU/Linux distro >= 2.6.37.6
- G++ >= 4.5.1
- GTKMM >= 3.2.1
- Satisfy all dependencies of the following external libraries
* GoogleTest - Google's Unit Testing Framework
Installation/Compilation/Running
================================
Please see "INSTALL".
Documentation
=============
Documentation for this project is generated using Doxygen. Please see
doc/DOXYGEN for details on how to compile documentation. Documentation from the
master branch is available on the project website.