This project serves as a CHIP-8 emulator/interpreter. The aim of this project is to introduce myself, and anyone following, to systems emulation. This project will (aim to) use best practices in C++, and best practices in git (good commit messages.)
Please use an out of source build method, for example:
mkdir build
cd ./build
cmake ../
make
and to run the project (relative to the new build folder we made):
./bin/CHIP8
Make sure you have installed:
- libx11-dev
- xorg-dev
- libglu1-mesa-dev
...
To maintain a consistent codebase, use the following style when formatting your code:
- Classes:
UpperCase
- Methods:
UpperCase
- Instance Variables:
lowerCase
- Class(static) Variables:
lowerCase
- Constants:
UNDER_SCORE_CAPS
- File Comments: Block Comments
/** ... */
, detailing:- file name (e.g. main.cpp),
@author
@version
- license
- optional description
- Function Comments: Block Comments
/** ... */
, detailing:- purpose,
@param
@return
- Code Comments: Use the double slash style
//
for all other comments.- Try not to over-comment, only comment when the code can't describe itself.