Added a more elaborate README
This commit is contained in:
parent
fa868bca57
commit
0948259f1e
64
README.md
64
README.md
|
@ -1,3 +1,63 @@
|
|||
# MagnaTech
|
||||
# Technetium
|
||||
|
||||
Hobbyist-grade block-based game.
|
||||
Hobbyist-grade block-based game.
|
||||
|
||||
## Building
|
||||
|
||||
Building Technetium is only possible in a Linux environment.
|
||||
|
||||
### Dependencies
|
||||
|
||||
Building Technetium requires two types of dependencies to be
|
||||
installed: 1) The system dependencies, and 2) Dependency Libraries.
|
||||
|
||||
The required system dependencies are:
|
||||
|
||||
- `bash`
|
||||
- GNU Compiler Collection (`gcc`)
|
||||
- Basic Utilities and Libraries (System Headers, pre-installed
|
||||
on most distros)
|
||||
|
||||
The dependency libraries are managed by the Technetium Build Script;
|
||||
it's not necessary to know about them for simply building the project.
|
||||
|
||||
It's still necessary to run the following two commands for cloning
|
||||
and building the dependencies:
|
||||
|
||||
```bash
|
||||
./build.bash update-deps
|
||||
./build.bash dependencies
|
||||
```
|
||||
|
||||
The first command gets the dependencies via Git and the second one builds it.
|
||||
|
||||
### Building the project
|
||||
|
||||
There are three different profiles in which Technetium can be built:
|
||||
|
||||
#### Release
|
||||
|
||||
Finished builds ready to be played.
|
||||
|
||||
```bash
|
||||
./build.bash release
|
||||
```
|
||||
|
||||
|
||||
#### Debug
|
||||
|
||||
In-development builds which are not meant to be played.
|
||||
|
||||
```bash
|
||||
./build.bash debug
|
||||
```
|
||||
|
||||
|
||||
#### Small
|
||||
|
||||
Tries to minimize the executable size. Interesting for comparison against the
|
||||
release mode or even debug mode, with their big executable size.
|
||||
|
||||
```bash
|
||||
./build.bash small
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue