Skip to content

Commit f63883b

Browse files
committed
Add some documentation
1 parent 9bc907f commit f63883b

3 files changed

Lines changed: 48 additions & 0 deletions

File tree

CMAKE_README.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
To generate build files for your platform run in a command terminal:
2+
cd Build
3+
cmake -G GENERATOR ..
4+
5+
Valid generators are:
6+
Windows:
7+
"Visual Studio 12 2013 Win64"
8+
"Visual Studio 14 2015 Win64"
9+
"Visual Studio 15 2017 Win64"
10+
Mac:
11+
"Xcode"
12+
Linux: (see note below)
13+
"Unix Makefiles"
14+
15+
Example: cmake -G "Visual Studio 12 2013 Win64" ..
16+
17+
For Linux Only:
18+
On linux, Debug and Release options are generated by cmake and must be specified like so:
19+
cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release ..
20+
or
21+
cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Debug ..
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
To generate build files for your platform run in a command terminal:
2+
cd Build
3+
cmake -G GENERATOR ..
4+
5+
Valid generators are:
6+
Windows:
7+
"Visual Studio 12 2013 Win64"
8+
"Visual Studio 14 2015 Win64"
9+
"Visual Studio 15 2017 Win64"
10+
Mac:
11+
"Xcode"
12+
Linux: (see note below)
13+
"Unix Makefiles"
14+
15+
Example: cmake -G "Visual Studio 12 2013 Win64" ..
16+
17+
For Linux Only:
18+
On linux, Debug and Release options are generated by cmake and must be specified like so:
19+
cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release ..
20+
or
21+
cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Debug ..

Resources/DeveloperTools/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Developer tools
2+
This folder contains tools that might be used by plugin developers.
3+
4+
## Available tools
5+
### Binary Builder
6+
A tool to compile binary resources like images or fonts into a .h and .cpp files so their contents can be easily accessed by C++ code.

0 commit comments

Comments
 (0)