mirror of
https://github.com/tildearrow/furnace.git
synced 2024-11-27 06:53:01 +00:00
update readme to clarify build process
This commit is contained in:
parent
629d229bc1
commit
fe30e09d16
1 changed files with 14 additions and 1 deletions
15
README.md
15
README.md
|
@ -50,6 +50,8 @@ check out the [documentation](papers/doc/README.md). it's mostly incomplete, but
|
||||||
|
|
||||||
# developer info
|
# developer info
|
||||||
|
|
||||||
|
**NOTE: do not download the project's source as a .zip or .tar.gz as these do not include the project's submodules which are necessary to proceed with building.**
|
||||||
|
|
||||||
## dependencies
|
## dependencies
|
||||||
|
|
||||||
- CMake
|
- CMake
|
||||||
|
@ -59,9 +61,20 @@ check out the [documentation](papers/doc/README.md). it's mostly incomplete, but
|
||||||
|
|
||||||
SDL2 and zlib are included as submodules.
|
SDL2 and zlib are included as submodules.
|
||||||
|
|
||||||
|
## getting the source
|
||||||
|
|
||||||
|
type the following on a terminal/console: (make sure Git is installed)
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone --recursive https://github.com/tildearrow/furnace.git
|
||||||
|
cd furnace
|
||||||
|
```
|
||||||
|
|
||||||
|
(the `--recursive` parameter ensures submodules are fetched as well)
|
||||||
|
|
||||||
## compilation
|
## compilation
|
||||||
|
|
||||||
your typical CMake project. clone (including submodules) and:
|
your typical CMake project.
|
||||||
|
|
||||||
### Windows using MSVC
|
### Windows using MSVC
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue