summaryrefslogtreecommitdiffstats
path: root/docs/quickstart.rst
diff options
context:
space:
mode:
authorMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2017-06-27 15:49:49 +0200
committerMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2017-06-27 15:49:49 +0200
commita4704b0e9c8fb1737854fca31531c5ce2c65e47a (patch)
treeb1d0f596b27287181d9e66cc79dae478db50e325 /docs/quickstart.rst
parent0aed0f5614507a3f4d521e6890a5ef05db8305e0 (diff)
downloaduca-a4704b0e9c8fb1737854fca31531c5ce2c65e47a.tar.gz
uca-a4704b0e9c8fb1737854fca31531c5ce2c65e47a.tar.bz2
uca-a4704b0e9c8fb1737854fca31531c5ce2c65e47a.tar.xz
uca-a4704b0e9c8fb1737854fca31531c5ce2c65e47a.zip
Update Windows build instructions
Diffstat (limited to 'docs/quickstart.rst')
-rw-r--r--docs/quickstart.rst64
1 files changed, 24 insertions, 40 deletions
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
index b154800..f84ebf8 100644
--- a/docs/quickstart.rst
+++ b/docs/quickstart.rst
@@ -103,60 +103,44 @@ Building on Windows
~~~~~~~~~~~~~~~~~~~
Using MSYS2, the build procedure is similar to Linux but differs in some points.
-To build libuca and the plugins:
+First, download msys2-<arch>-<release-date>.exe from `msys2.org
+<https://msys2.org/>`_ (preferably the x86_64 variant) and install it to
+``C:\msys64`` or any other location.
-Get msys2 from `msys2.github.io <https://msys2.github.io/>`_ (preferably the
-x86_64 variant) and install it to ``C:\msys64`` or any other location.
-
-Run ``mingw64_shell.bat`` from the ``C:\msys64`` folder` to open up a msys2 shell
-and use the pre-installed ``pacman`` package manager to install required packages.
-Before that, please update core msys packages and restart the shell after
-running::
+Run the MSYS2 MinGW shell from the start menu and update the core if this is the
+first time using::
pacman -Syu
-Now install the dependencies via ``pacman -S <package_name>``. Following is a
-list of required packages:
+Close the terminal and open a new shell again. Install all required dependencies
+with::
-- ``make``
-- ``perl``
-- ``mingw-w64-x86_64-gcc``
-- ``mingw-w64-x86_64-gdb``
-- ``mingw-w64-x86_64-pkg-config``
-- ``mingw-w64-x86_64-gtk2``
+ pacman -S make cmake pkg-config git glib2-devel gettext-devel
-Create an empty ``build`` directory in libuca's root folder, change directory to
-that folder and configure libuca using CMake::
+Clone libuca and any plugins you want to use on Windows::
- cmake -G "MSYS Makefiles" -D CMAKE_INSTALL_PREFIX="C:\uca" -D CMAKE_BUILD_TYPE=Debug ..
+ git clone https://github.com/ufo-kit/libuca
-Now you can type::
+and create an empty ``build`` directory in libuca's root folder. Change
+directory to that folder, configure libuca using CMake and build and install it::
+ cd libuca
+ mkdir build && cd build
+ cmake -DCMAKE_INSTALL_PREFIX=/usr ..
make && make install
-to create and install all binaries and libraries in ``C:\uca``.
-
-
-Building plugins
-^^^^^^^^^^^^^^^^
-
-.. note::
+Before proceeding with the plugins you *must* soft link the library to fit the
+naming scheme::
- A package config file (libuca.pc) is generated when libuca is built
- and is stored in folder pkgconfig in ``C:\uca\bin``. This file is used while
- building uca plugins to locate shared libraries of libuca. To help find them add
- the location to the package config search path using the environment variable
- ``PKG_CONFIG_PATH``, i.e. run::
+ ln -s /usr/lib/libuca.so /usr/lib/libuca.dll.a
- PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/c/uca/bin/pkgconfig/
-
-Now, create an empty ``build`` directory in the plugin root folder, change
-directory to that folder and configure the plugin using::
-
- cmake -G "MSYS Makefiles" -D CMAKE_INSTALL_PREFIX="C:\uca" -D CMAKE_BUILD_TYPE=Debug ..
-
-As before, build and install the plugin using::
+To build plugins nothing special is required. Clone the repository, create an
+empty build directory, configure and build::
+ git clone https://github.com/ufo-kit/uca-net
+ cd uca-net
+ mkdir build && cd build
+ cmake ..
make && make install