diff --git a/docs/BUILD-INSTRUCTIONS-LINUX.md b/docs/BUILD-INSTRUCTIONS-LINUX.md index b84cc27..826045f 100644 --- a/docs/BUILD-INSTRUCTIONS-LINUX.md +++ b/docs/BUILD-INSTRUCTIONS-LINUX.md @@ -1,7 +1,7 @@ gLabels Linux Build Instructions ================================ -# Prerequisites +## Prerequisites - g++ - CMake 2.8.12+ @@ -12,7 +12,7 @@ gLabels Linux Build Instructions > may also need to be installed. Development packages are usually named something like > libraryName-dev or libraryName-devel. -# Cloning/Downloading +## Cloning/Downloading To clone the gLabels source: @@ -21,7 +21,7 @@ $ git clone https://github.com/jimevins/glabels-qt.git ``` -# Compiling and Install +## Compiling and Install gLabels uses the CMake meta build system. Use the following commands to build and install gLabels (assuming you are still in the directory that you ran `git clone` from): diff --git a/docs/BUILD-INSTRUCTIONS-WINDOWS.md b/docs/BUILD-INSTRUCTIONS-WINDOWS.md new file mode 100644 index 0000000..08f7792 --- /dev/null +++ b/docs/BUILD-INSTRUCTIONS-WINDOWS.md @@ -0,0 +1,52 @@ +gLabels Windows Build Instructions +================================== + +gLabels for Windows can be built using one of the following toolchains: + +- [MSYS/MINGW](#msysmingw) +- [Visual Studio](#visual-studio) + + +MSYS/MINGW +---------- + +### Prerequisites + +- MSYS/MINGW, including the following packages + . mingw32-gcc-g++ + . mingw32-libz +- CMake 2.8.12+ +- Qt5 5.4+ for MINGW + +Make sure that Qt tools are in your executable search path. For example, add something like this to your .profile file: + +``` +export PATH=/c/Qt/Qt5.6.0/5.6/mingw49_32/bin:${PATH} +``` + +The exact path will depend on the version of Qt and MINGW you have installed. + + +### Cloning/Downloading + +To download, select **Download ZIP** on the [glabels-qt Github page](https://github.com/jimevins/glabels-qt). Unzip this file into your MSYS home directory (e.g. */mingw/msys/1.0/home/yourname*). + + +### Compiling and Install + +gLabels uses the CMake meta build system. From the MSYS shell, type the following commands: + +``` +$ cd glabels-qt-master +$ mkdir build +$ cd build +$ cmake .. +$ make install +``` + + + +Visual Studio +------------- + +TBD \ No newline at end of file