Go to file
2018-03-25 17:04:14 +02:00
build First steps. 2018-03-25 12:08:19 +02:00
src Remove help and info from key list. 2018-03-25 17:04:14 +02:00
.gitignore First steps. 2018-03-25 12:08:19 +02:00
CHANGELOG Added section of v0.3. 2018-03-25 15:46:46 +02:00
CMakeLists.txt Add fast-math optimization for release builds. 2018-03-25 16:40:56 +02:00
LICENSE Initial commit 2014-05-26 16:01:46 -05:00
README New install target. 2018-03-25 12:30:39 +02:00

====================
*** SpaceShipSim ***
====================
This is a small simulation program of a space ship (with infinite fuel) in a
frictionless environment (space). The idea is to use it for educational
purposes.

# Compiling
-----------
In order to build this program you will require the following dependencies:

 - GNU GCC (https://gcc.gnu.org/)
 - CMake (https://cmake.org/)
 - Allegro 5 (http://liballeg.org/)

You can then compile the program via the following commands:

  cd build/
  cmake ..
  make

This will create a release build with compiler optimizations. If you would like
a debug build then pass the `-DCMAKE_BUILD_TYPE=debug' flag to the `cmake'
command. If you would like to install then run `cmake' with the additional flag
`-DCMAKE_INSTALL_PREFIX=<install_dir>'. If you are installing as a user then
you may want to set the installation prefix to `/usr/local/', and if you're
packaging then please consult your distribution's policies. With this you
should be able to run the `make install' target and install the binary.

# Contributing
--------------
If you would like to contribute to the project, send a patch file to my e-mail
address: <nortega@themusicinnoise.net>.

# License
---------
As educational software, unless otherwise noted, all files are licensed under
the terms & conditions of the GNU General Public License version 3 or greater
(see `LICENSE' file for more information).