From 19289f800e487564e481b1609b8aaac98d3d6cc2 Mon Sep 17 00:00:00 2001
From: "patrick.roth" <roth@stettbacher.ch>
Date: Mon, 21 Oct 2019 09:43:33 +0200
Subject: building instructions for windows added

---
 README.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 75 insertions(+), 5 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 6e6fe08..2eaf4aa 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ freely available. These cameras are developed and produced in Switzerland.
 
 ## Color Image Processing Pipeline
 The pipeline applies serveral algorithms to captured images from the O-3000 camera. Following pipeline
-stages are implemented:
+stages exist:
 <ol>
 <li>Debayering</li>
 <li>Auto white balancing</li>
@@ -17,10 +17,12 @@ stages are implemented:
 <li>Gamma correction</li>
 </ol>
 
+### Build and install for Linux
+Make sure you've all tools for compiling and linking applications. Futher the tool *cmake*
+is required and the O-3000 driver must be installed. Run following commands in a shell:
 
-### Build and install
 ```
-git clone https://stettbacher.ch/gitlab/o-3000/driver.git
+git clone https://stettbacher.ch/gitlab/o-3000/color-pipe.git
 cd color-pipe
 mkdir build
 cd build
@@ -28,11 +30,79 @@ cmake ..
 sudo make install
 ```
 
+### Build and install for Windows
+This will install the free and open source software development
+environment MinGW on your Windows system. MSYS2 contains a command line shell for development
+usage and the MinGW compiler. Further informations are found here:
+
+* [1] https://wiki.qt.io/MSYS2
+* [2] http://www.msys2.org/
+
+Download and execute newest MSYS2 installer version from [2]. Use the default
+installation path *C:\msys64*. Otherwise MSYS might have a problem.
+
+Run MSYS2-shell and update core components:
+
+```
+pacman -Sy
+pacman --needed -S bash pacman pacman-mirrors msys2-runtime
+```
+
+You must exit out from MSYS2-shell, restart MSYS2-shell, then run below
+command to complete rest of other component's update:
+
+```
+pacman -Su
+```
+
+Exit out of MSYS2-shell, restart MSYS2-shell, then you are ready to use MSYS2-shell. Double-check
+whether MSYS is up-to-date:
+
+```
+pacman -Su
+```
+
+Install several tools for software development and building O-3000 libraries and applications.
+This will install 32 and 64 bit toolchains:
+
+```
+pacman -S base-devel git 
+pacman -S mingw-w64-i686-toolchain mingw-w64-x86_64-toolchain mingw-w64-i686-cmake mingw-w64-x86_64-cmake
+pacman -S mingw64/mingw-w64-x86_64-libusb mingw32/mingw-w64-i686-libusb
+```
+
+Exit MSYS2-shell and run MSYS2-MinGW-shell located here:
+
+```
+C:\Users\<USER>\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\MSYS2 64bit
+```
+
+You can choose between a 32 and 64 bit platform. Choose whichever you prefer.
+
+Build O-3000 Image Pipeline:
+
+```
+mkdir o-3000-git
+cd o-3000-git
+git clone https://stettbacher.ch/gitlab/o-3000/color-pipe.git
+cd color-pipe
+mkdir build
+cd build
+cmake .. -G "MSYS Makefiles" -DCMAKE_INSTALL_PREFIX=$MSYSTEM_PREFIX
+make
+```
+
+You'll find the DLL library at your building directory. If you want to install the library to the
+MSYS2 system path, run following command:
+
+```
+make install
+```
 
 ### Cross-Compile
 A toolchain file is needed to specify the cross-compiler environment. As a starting point,
-use the template 'cmake/toolchain_file_template.cmake'. Specify the cross-compiler and path. 
-Run cmake within build directory as follow:
+use the template 'cmake/toolchain_file_template.cmake'. Do specify the cross-compiler and path. 
+Run the cmake command as follow:
 
 ```
 cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/toolchain_file_template.cmake ..
-- 
cgit v1.2.1