Skip to content

Commit e6ddeb1

Browse files
committed
Update ReadMe
1 parent 9b441d6 commit e6ddeb1

2 files changed

Lines changed: 34 additions & 1 deletion

File tree

.github/resources/images/Menu1.png

24.6 KB
Loading

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,34 @@
1-
# Incaribus
1+
<p align="center">
2+
<img src=".github/resources/images/Menu1.png">
3+
</p>
4+
5+
# Incaribus
6+
7+
## Description
8+
This project provide an example designed with [ShipWreck](https://docs.creative-rift.com/) Engine.
9+
You follow a little fox and travel around the world to collect all gems. </br>
10+
WARNING: This project may contain experimental feature.
11+
Please if an issue occur, report them on the [issue tracker](https://github.com/Creative-Rift/Incaribus/issues).
12+
13+
## Compilation
14+
15+
To build the project simply use these commands:
16+
17+
```bash
18+
mkdir build ; cd build
19+
cmake -G "Visual Studio 17 2022" -DCMAKE_BUILD_TYPE=[Debug/Release] ..
20+
cmake --build . --target Incaribus --config [Debug/Release]
21+
```
22+
23+
The output program will be in `Incaribus/out/[Debug/Release]/incaribus.exe` \
24+
PS: Run the game directly from the folder, or resources will not be found.
25+
26+
# Asset Pack
27+
28+
In this project we use the awesome [Sunny Land](https://ansimuz.itch.io/sunny-land-pixel-game-art) asset pack.
29+
30+
## Author
31+
32+
Made on our ship with :heart: \
33+
34+
[Guillaume Soisson](https://github.com/Alvarwow69)

0 commit comments

Comments
 (0)