nortega/spaceshipsim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Change README to markdown.

Browse Source
This commit is contained in:
Nicolás A. Ortega Froysa
2026-03-03 09:26:50 +01:00
parent da8d83de92
commit c1139ddb81
1 changed files with 20 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
README → README.md
View File

@@ -1,39 +1,40 @@
==================== # SpaceShipSim
*** SpaceShipSim ***
====================
This is a small simulation program of a space ship (with infinite fuel) in a 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 frictionless environment (space). The idea is to use it for educational
purposes. purposes.
# Compiling ## Compiling
-----------
In order to build this program you will require the following dependencies: In order to build this program you will require the following dependencies:
- GNU GCC (https://gcc.gnu.org/) - GNU GCC ([https://gcc.gnu.org/])
- CMake (https://cmake.org/) - CMake ([https://cmake.org/])
- Allegro 5 (http://liballeg.org/) - Allegro 5 ([http://liballeg.org/])
You can then compile the program via the following commands: You can then compile the program via the following commands:
cd build/ ```bash
cmake .. cd build/
make cmake ..
make
```
This will create a release build with compiler optimizations. If you would like 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' 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 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 `-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 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 packaging then please consult your distribution's policies. With this you
should be able to run the `make install' target and install the binary. should be able to run the `make install' target and install the binary.
# Contributing ## Contributing
--------------
If you would like to contribute to the project, send a patch file to my e-mail If you would like to contribute to the project, send a patch file to my e-mail
address: <nortega@themusicinnoise.net>. address: <nortega@themusicinnoise.net>.
# License ## License
---------
As educational software, unless otherwise noted, all files are licensed under As educational software, unless otherwise noted, all files are licensed under
the terms & conditions of the GNU General Public License version 3 or greater the terms & conditions of the GNU General Public License version 3 or greater
(see `LICENSE' file for more information). (see `LICENSE' file for more information).