diff options
| author | Matthias Vogelgesang <matthias.vogelgesang@kit.edu> | 2016-05-04 11:53:00 +0200 |
|---|---|---|
| committer | Matthias Vogelgesang <matthias.vogelgesang@kit.edu> | 2016-05-04 11:53:00 +0200 |
| commit | ad45d3ed62a29181b051b720f3b26866e87ca8d7 (patch) | |
| tree | f11b4abcbf5bec954b46e6f018528eaf3a977350 | |
| parent | bdc6f0f6babc093f58a182f424c86f3f436c3a8a (diff) | |
| download | libuca-ad45d3ed62a29181b051b720f3b26866e87ca8d7.tar.gz libuca-ad45d3ed62a29181b051b720f3b26866e87ca8d7.tar.bz2 libuca-ad45d3ed62a29181b051b720f3b26866e87ca8d7.tar.xz libuca-ad45d3ed62a29181b051b720f3b26866e87ca8d7.zip | |
docs: improve layout a bit
| -rw-r--r-- | docs/quickstart.rst | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/docs/quickstart.rst b/docs/quickstart.rst index e2f3aa9..05f8df1 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -100,8 +100,8 @@ Building on Windows Using MSYS2, the build procedure is similar to Linux but differs in some points. To build libuca and the plugins: -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. +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. @@ -135,13 +135,15 @@ to create and install all binaries and libraries in ``C:\uca``. Building plugins ^^^^^^^^^^^^^^^^ -Note: 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:: +.. note:: - PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/c/uca/bin/pkgconfig/ + 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:: + + 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:: |