Update documentation
This commit is contained in:
parent
01f21e63c9
commit
8729fb1e87
13
README.md
13
README.md
|
@ -42,8 +42,8 @@ Besides, the library provides a few useful algorithms and data structures:
|
||||||
## Build instructions
|
## Build instructions
|
||||||
### Requirements
|
### Requirements
|
||||||
#### Build-only dependencies
|
#### Build-only dependencies
|
||||||
* C++ compiler supporting C++14, tested with
|
* C++ compiler supporting C++17, tested with
|
||||||
- clang++ to compile for GNU/Linux and MacOS X
|
- clang++ to compile for GNU/Linux and Android
|
||||||
- g++ to compile for GNU/Linux and Windows
|
- g++ to compile for GNU/Linux and Windows
|
||||||
* CMake (at least 3.3.0)
|
* CMake (at least 3.3.0)
|
||||||
* cppunit for unit tests (optional)
|
* cppunit for unit tests (optional)
|
||||||
|
@ -54,9 +54,9 @@ Besides, the library provides a few useful algorithms and data structures:
|
||||||
|
|
||||||
#### Runtime dependencies
|
#### Runtime dependencies
|
||||||
* The c++utilities library itself only needs
|
* The c++utilities library itself only needs
|
||||||
* C++ standard library supporting C++14, tested with
|
* C++ standard library supporting C++17, tested with
|
||||||
- libstdc++ under GNU/Linux, Windows and MacOS X
|
- libstdc++ under GNU/Linux and Windows
|
||||||
- libc++ under GNU/Linux
|
- libc++ under GNU/Linux and Android
|
||||||
* iconv (might be part of glibc or provided as extra library)
|
* iconv (might be part of glibc or provided as extra library)
|
||||||
* For dependencies of my other projects check the README.md of these projects.
|
* For dependencies of my other projects check the README.md of these projects.
|
||||||
|
|
||||||
|
@ -79,8 +79,7 @@ make DESTDIR="/temporary/install/location" install
|
||||||
* The make option ```-j``` can be used for concurrent compilation.
|
* The make option ```-j``` can be used for concurrent compilation.
|
||||||
* ```LIB_SUFFIX```, ```LIB_SUFFIX_32``` and ```LIB_SUFFIX_64``` can be set to
|
* ```LIB_SUFFIX```, ```LIB_SUFFIX_32``` and ```LIB_SUFFIX_64``` can be set to
|
||||||
specify a suffix for the library directory, eg. lib*64* or lib*32*. The 32/64 variants are only used when building for 32/64-bit architecture.
|
specify a suffix for the library directory, eg. lib*64* or lib*32*. The 32/64 variants are only used when building for 32/64-bit architecture.
|
||||||
* By default the build system will *build* shared libs. To *build* also static libraries, set `ENABLE_STATIC_LIBS=ON`. To disable building shared libs
|
* By default the build system will *build* static libs. To *build* shared libraries *instead*, set `BUILD_SHARED_LIBS=ON`.
|
||||||
set `DISABLE_SHARED_LIBS=ON`.
|
|
||||||
* By default the build system will prefer *linking against* shared libraries. To force *linking against* static libraries set `STATIC_LINKAGE=ON`.
|
* By default the build system will prefer *linking against* shared libraries. To force *linking against* static libraries set `STATIC_LINKAGE=ON`.
|
||||||
However, this will only affect applications. To force linking statically when building shared libraries set `STATIC_LIBRARY_LINKAGE=ON`.
|
However, this will only affect applications. To force linking statically when building shared libraries set `STATIC_LIBRARY_LINKAGE=ON`.
|
||||||
* If thread local storage is not supported by your compiler/platform (might be the case on MacOS), you can disable making use of it
|
* If thread local storage is not supported by your compiler/platform (might be the case on MacOS), you can disable making use of it
|
||||||
|
|
|
@ -241,12 +241,9 @@ and qtutilities.
|
||||||
* `META_PRIVATE/PUBLIC_COMPILE_DEFINITIONS`: specifies private/public compile
|
* `META_PRIVATE/PUBLIC_COMPILE_DEFINITIONS`: specifies private/public compile
|
||||||
definitions
|
definitions
|
||||||
* `LIBRARIES`: specifies libraries to link against
|
* `LIBRARIES`: specifies libraries to link against
|
||||||
* `META_PUBLIC_QT_MODULES`: specifies Qt modules used in the public library
|
* `ADDITIONAL_QT_MODULES`: specifies additional Qt modules to link against
|
||||||
interface
|
* `ADDITIONAL_KF_MODULES`: specifies additional KDE frameworks modules to link
|
||||||
* `META_PUBLIC_SHARED_LIB_DEPENDS`: specifies shared libraries used in the public
|
against
|
||||||
library interface
|
|
||||||
* `META_PUBLIC_STATIC_LIB_DEPENDS`: specifies static libraries used in the public
|
|
||||||
library interface
|
|
||||||
|
|
||||||
## Provided modules
|
## Provided modules
|
||||||
c++utilities and qtutilities provide CMake modules to reduce boilerplate code
|
c++utilities and qtutilities provide CMake modules to reduce boilerplate code
|
||||||
|
|
Loading…
Reference in New Issue