natsirt/noggit-red
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Skarn
2022-02-13 16:58:35 +00:00
parent 390adc74cd
commit 2285e51c7d
1 changed files with 11 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -3,14 +3,20 @@ This software is open source software licensed under GPL3, as found in
the COPYING file. the COPYING file.
# BUILDING # # BUILDING #
This project requires CMake to be built. It also requires the This project requires CMake to be built.
It also requires the
following libraries: following libraries:
* OpenGL * OpenGL
* StormLib (by Ladislav Zezula) * StormLib (by Ladislav Zezula)
* CascLib (by Ladislav Zezula) * CascLib (by Ladislav Zezula)
* Boost * Qt5
* Qt 5 * Lua5.x
On Windows you only need to install Qt5 yourself, the rest of the depencies are pulled through FetchContent automatically.
Supporting for Linux and Mac for this feature is coming in the future.
In case FetchContent is not available (e.g. no internet connection), the find scripts will look for system installed libraries.
Further following libraries are required for MySQL GUID Storage builds: Further following libraries are required for MySQL GUID Storage builds:
@@ -29,14 +35,6 @@ corresponding versions for other dependencies.
### CMake ### ### CMake ###
Any recent CMake 3.x version should work. Just take the latest. Any recent CMake 3.x version should work. Just take the latest.
### Boost ###
Install boost to `<boost-install>`. The easiest is to download a pre-built
package from https://sourceforge.net/projects/boost/files/boost-binaries/.
* Any version from the last years should work, 1.60 at least.
* Be sure to pick the right compiler version!
* CMake may not support the latest version yet, if you have bad timing, try picking the second newest if configuring fails.
### Qt5 ### ### Qt5 ###
Install Qt5 to `<Qt-install>`, downloading a pre-built package from Install Qt5 to `<Qt-install>`, downloading a pre-built package from
https://www.qt.io/download-open-source/#section-2. https://www.qt.io/download-open-source/#section-2.
@@ -46,6 +44,7 @@ also only **one** compiler version. If download size is noticably large
(more than a few hundred MB), you're probably downloading way too much. (more than a few hundred MB), you're probably downloading way too much.
### StormLib ### ### StormLib ###
This step is only required if pulling the dependency from FetchContent is not available.
Download StormLib from https://github.com/ladislav-zezula/StormLib (any Download StormLib from https://github.com/ladislav-zezula/StormLib (any
recent version). recent version).
@@ -247,4 +246,4 @@ Additional examples:
constexpr unsigned SOME_CONSTANT = 10; // constants are named in SCREAMING_CASE constexpr unsigned SOME_CONSTANT = 10; // constants are named in SCREAMING_CASE
#define SOME_MACRO // macro definitions are named in SCREAMING_CASE #define SOME_MACRO // macro definitions are named in SCREAMING_CASE
``` ```