Skip to content

Commit

Permalink
Update build instructions in README
Browse files Browse the repository at this point in the history
  • Loading branch information
mdsteele committed Jun 28, 2018
1 parent 9a0be8d commit 89f9b48
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,32 +17,34 @@ either in Framework form or via e.g. MacPorts, and the Makefile should be able
to sort it out. On Debian, all it should take is:

```shell
$ sudo apt-get install libsdl1.2-dev
$ sudo apt-get install libgl-mesa-dev libsdl1.2-dev
```

### Building and running

From the root of the repository, run:
To build and run a debug build of the game, run:

```shell
$ make # Compiles everything.
$ make test # Runs unit tests, to make sure things look okay on your system.
$ make run # Starts the game.
```

The final packaged game will be output to `out/debug/Azimuth.app` on Mac, or to
`out/debug/Azimuth` on Linux. (If you try to run the executable found at
`out/debug/bin/azimuth`, it won't be able find the game resource files.)

You can also build a release version with:
To build and install a packaged app on Mac OS X, run:

```shell
$ BUILDTYPE=release make
$ BUILDTYPE=release make test
$ BUILDTYPE=release make run
$ BUILDTYPE=release make macosx_app
$ mv -i out/release/host/Azimuth.app /Applications/
$ open /Applications/Azimuth.app
```

in which case the outputs will be found in `out/release/` instead.
To build and install a packaged app on Debian, run:

```shell
$ BUILDTYPE=release make linux_deb
$ sudo dpkg -i out/release/host/azimuth_*.deb
$ azimuth
```

## License

Expand Down

0 comments on commit 89f9b48

Please sign in to comment.