Martchus
/
cpp-utilities
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated build instructions

This commit is contained in:
Martchus 2016-01-29 00:47:05 +01:00
parent 93582b4ac0
commit d71e6c56d4
1 changed files with 33 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -2,24 +2,46 @@
Common C++ classes and routines used by my applications such as argument parser, IO and conversion utilities. Common C++ classes and routines used by my applications such as argument parser, IO and conversion utilities.
## Build instructions ## Build instructions
Building the library is simple: ### Requirements
``` * C++ compiler supporting C++11 (I've tested GNU g++, Clang and mingw-w64 yet.)
INSTALL_ROOT=/where/you/want/to/install qmake-qt5 c++utilities.pro * CMake to build
make && make install * cppunit to build and run unit tests after building
``` * The c++utilities library only depends on the C++ standard library. For Dependencies of my other projects
As you can see, the qmake build system is used. However the library itself does *not* depend on Qt. see the README.md of these projects.
It is also possible to build the library using CMake: ### How to build
Just run:
``` ```
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/where/you/want/to/install project/directory cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX="/where/you/want/to/install" "path/to/projectdirectory"
make
make check # build and run unit tests (optional)
make install
```
Building with qmake is also possible:
```
INSTALL_ROOT="/where/you/want/to/install" qmake-qt5 "path/to/projectfile"
make && make install make && make install
``` ```
In any case, the make option *-j* might be used to compile multiple files in parallel. Building for Windows with Mingw-w64 cross compiler can be utilized using a small
[cmake wrapper from Fedora](https://aur.archlinux.org/cgit/aur.git/tree/mingw-cmake.sh?h=mingw-w64-cmake):
```
${_arch}-cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX="/where/you/want/to/install" "path/to/projectdirectory"
make && make install
```
To create *.ico files for application icons ffmpeg is required.
The repository PKGBUILDs (also on GitHub) contains files for building Arch Linux packages. A PKGBUILD file to build for Windows using the Mingw-w64 compiler is also included. In any case, the make option *-j* can be used for concurrent compilation.
### Creating Arch Linux package
The repository PKGBUILDs (also on GitHub) contains files for building Arch Linux packages.
PKGBUILD files to build for Windows using the Mingw-w64 compiler are also included.
### Notes
* Because of [GCC Bug 66145](https://gcc.gnu.org/bugzilla/show_bug.cgi?id=66145) usage of the new libstdc++ ABI
is currently disabled. Linking against cppunit built using new libstdc++ ABI isn't possible.
## TODO ## TODO
- provide unit tests
- rewrite argument parser - rewrite argument parser
- remove unused features - remove unused features