aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--[l---------]README47
1 files changed, 46 insertions, 1 deletions
diff --git a/README b/README
index 842bf0e..d0ec659 120000..100644
--- a/README
+++ b/README
@@ -1 +1,46 @@
-INSTALL \ No newline at end of file
+Howto Build
+===========
+
+Basically there are four different possible build configurations which are (more or less) well-tested.
+All builds require a full C++2011 toolchain! Microsoft's VisualStudio2013 won't work since it's not fully C++2011 compatible!
+You can either use a Linux toolchain with g++/clang or a mingw64-g++ toolchain for Windows builds.
+
+Linux:
+ - non-GUI build
+ - GUI build linked against a static wxWidgets library
+ - GUI build linked against a dynamic wxWidgets library
+Windows:
+ - GUI build linked against a static wxWidgets library
+
+Untested:
+ - Windows non-GUI build
+ - Windows GUI build with a dynamic wxWidgets library
+
+
+Build with a shipped (static) wxWidgets version
+===============================================
+
+1. Run `build_wxwidgets.sh [target-triplet]`
+ where [target-triplet] should look like cpu-vendor-os e.g. i686-w64-mingw32 if you are building for Windows
+ Example: `./build_wxwidgets.sh i686-w64-mingw32`
+
+2. Run `./autogen.sh`
+ and add an additional `--help` to set some package options.
+ Example: `./autogen.sh --disable-gui`
+
+3. Run `make` or `make -j4` or `make -j4 V=1`
+ The argument -jN specifies the number of parallel build jobs.
+ The argument V=1 specifies a verbose compilation mode.
+
+
+Build with a dynamic wxWidgets version
+======================================
+
+1. Run `./autogen.sh --enable-host-wxwidgets`
+ Build a dynamic linked version.
+
+2. Run `make` (see above)
+
+
+For a successful host-wxwudgets build you'll need an extra package.
+`./autogen.sh --enable-host-wxwidgets`: libwxbase3.0-dev