Tic-Tac-Toe
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Initial commit May 20, 2015
COPYING
Makefile
README
README.md Initial commit May 20, 2015
ttt.c

README.md

ttt

Simple arbitrary-size tic-tac-toe game.

History

ttt was designed and written in response to a challenge from a colleague who wrote a console tic-tac-toe game in C++. The code was (frankly) written sloppily, and the program's structure severely limited its modularity. Furthermore, it was dependent on external commands unique to Microsoft operating systems (such as cls to clear the console).

I decided I would rewrite the game using clean C code, require no outside dependencies (besides the standard C library), and allow a board of variable size. I achieved a program with significant improvements in runtime efficiency (measured with controlled tests and inputs on one machine) which could be recompiled to use different board sizes.

I'm very pleased with the result, and I now use this as a test program when developing on new systems.

Usefulness

This program makes for an advanced "hello world" program for aspiring hackers that want a good sample to study and change.

The C code complies with C standards, and it can be compiled and run on any compliant system. It makes use of several standard library features and showcases their uses. Since the code is documented using a standard format, readers can understand a function's purpose before reading it, thus better understanding the code as a whole.

I used make to automate compilation not because compiling is hard (I could easily have written the instructions in this README file) but as a "hello world" for Makefiles, since hackers will no doubt need build automation tools for their more significant software.

Since the source is controlled using Git, I also provided a way for new hackers to practice using Git and learn the advantages of source control. It also allows them to easily submit their changes and improvements to me to benefit future hackers.

To Build

You will need a standards-compliant C compiler, the standard C library with header files, and make. On Debian GNU/Linux and derivatives, you can install these with

# apt-get install build-essential

After that, build with

$ make

To Install

If you want to install this program, just run

# make install

Usage

The board is labeled with coordinates of letters and numbers. When placing a move, write the letter and then the number. For example, to put your mark in the very first cell, type a0 as your position.

Hacking

Match the style you see in the source code. Do not use spaces for indentation. All functions and fields outside of main() should be documented using Doxygen comment formatting.

Avoid depending on external libraries with your changes. You will need to discuss with me (David McMackins II) if you want new dependencies to be added to the main program.

License

ttt is free software, released under the terms of version 0.5 of the Copyfree Open Innovation License. You are free to copy, modify, and redistribute this software and use it for whatever purpose. See COPYING for more details.