Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexOberhofer committed Jul 7, 2019
1 parent aa2c955 commit 61fc44f
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# Space Invaders

<p align="center">
<img src="https://github.com/AlexOberhofer/Space-Invaders/raw/master/doc/attract.PNG" alt="Chip 8 Image"/>
</p>

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.

Expand All @@ -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
Expand All @@ -56,6 +67,10 @@ C - INSERT COIN
X - START GAME
```

```
Z - COLOR MODE TOGGLE
```

Gameplay Controls

```
Expand Down

0 comments on commit 61fc44f

Please sign in to comment.