Skip to content

Commit

Permalink
Fill out the instructions for building some more
Browse files Browse the repository at this point in the history
  • Loading branch information
binji committed Feb 24, 2017
1 parent 788dd1e commit c77aa64
Showing 1 changed file with 34 additions and 3 deletions.
37 changes: 34 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,39 @@ A simple GB emulator.
## Building

Requires [CMake](https://cmake.org) and
[SDL2](http://libsdl.org/download-2.0.php). If you run `make`, it will run
CMake for you and put the output in the `bin/` directory.
[SDL2](http://libsdl.org/download-2.0.php).

### Building (Linux/Mac)

If you run `make`, it will run CMake for you and put the output in the `bin/`
directory.

```
$ make
$ bin/binjgb foo.gb
```

You can also just use cmake directly:

```
$ mkdir build
$ cd build
$ cmake ..
$ make
```

### Building (Windows)

When building on Windows, you'll probably have to set the SDL2 directory:

```
> mkdir build
> cd build
> cmake .. -G "Visual Studio 14 2015" -DSDL2_ROOT_DIR="C:\path\to\SDL\"
```

Then load this solution into Visual Studio and build it. Make sure to build the
`INSTALL` target, so the exectuables are built to the `bin` directory.

## Running

Expand Down Expand Up @@ -73,4 +104,4 @@ $ scripts/tester.py gpu

## Test status

[Test Results](test_results.md)
[See test results](test_results.md)

0 comments on commit c77aa64

Please sign in to comment.