diff --git a/README.md b/README.md index 9b031e9..0acb808 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,12 @@ # Space Invaders +
+ +
+ An Emulation of the Intel 8080 version of Space Invaders, implemented in C using SDL2. This emulator is still under development. + ## Building A makefile is provided for gnu/linux systems. This requires the SDL2 library, clang, and make to build. @@ -24,12 +29,18 @@ $ make ## Running -This emulator requires a singular rom file "invaders.rom" to be located in the res directory. A single rom file can be created from the individual space invaders roms by following the shell command below. +This emulator requires a singular rom file "invaders.rom" to be located in the /res/ directory. A single rom file can be created from the individual space invaders roms by following the shell command below. ``` $ cat invaders.h invaders.g invaders.f invaders.e > invaders.rom ``` +The program can be run with the following command when compiled from the root project directory. + +``` +$ ./bin/invaders +``` + This project is currently a work in progress. ## Controls @@ -56,6 +67,10 @@ C - INSERT COIN X - START GAME ``` +``` +Z - COLOR MODE TOGGLE +``` + Gameplay Controls ```