added documentation for CMake

This commit is contained in:
jkriege2 2019-06-20 22:38:51 +02:00
parent 5e8081e088
commit d104356f31
4 changed files with 19 additions and 0 deletions

View File

@ -37,6 +37,7 @@ This software is licensed under the term of the [GNU Lesser General Public Licen
- geometric forms/annotations
- can be easily extended by deriving a new graph from JKQTPPlotElement or JKQTPPlotObject
- optional: OpenCV interface
- CMake-based build system
- extensive set of [Examples/Tutorials](./examples/README.md)
- extensive doxygen-generated [Documentation](http://jkriege2.github.io/JKQtPlotter/index.html)

View File

@ -5,6 +5,22 @@ This page explains how to use JKQTPlotter in your own Projects
\tableofcontents
\section page_buildinstructions_CMAKE Build using CMake
The preferred way to build JKQTPlotter is using CMake. The CMake-build is defined in `CMakeLists.txt` files, found in many of the directories of the code repository.
You can build JKQTPlotter (and also the examples) by:
- Either opening the file <a href="https://github.com/jkriege2/JKQtPlotter/blob/master/CMakeLists.txt">CMakeLists.txt</a> in QTCreator (which has CMake integration)
- Or by calling something like this from the source directory:
\code{.sh}
$ mkdir build; cd build
$ cmake ../
$ make
$ make install
\endcode
.
\section page_buildinstructions_QMAKE Build using QMake
\subsection page_buildinstructions_QMAKEINCLUDE QMake Include Project
If you want to simply include the JKQTPlotter Source code into your projects, without build a shared or static library and linking against it, you can use one of these QMake-Include files:

View File

@ -53,6 +53,7 @@
- is optimized for fast plotting, but is not as feature-rich as JKQTPlotter
- may be used independently of JKQTPlotter
- for more details, see: \ref jkqtfastplotter
- CMake-based build system
- \ref exampleTutorialProjects "extensive set of Examples and Tutorials"
- extensive doxygen-generated <a href="http://jkriege2.github.io/JKQtPlotter/index.html">Online-Documentation (http://jkriege2.github.io/JKQtPlotter/index.html)</a>
- source code hosted&developed on GitHub <a href="https://github.com/jkriege2/JKQtPlotter">https://github.com/jkriege2/JKQtPlotter</a> (including continuous integration builds: <a href="https://ci.appveyor.com/project/jkriege2/jkqtplotter/branch/master">https://ci.appveyor.com/project/jkriege2/jkqtplotter/branch/master</a>)

View File

@ -16,6 +16,7 @@ Starting in summer 2018, JKQTPlotter received some major workover. During this,
Changes, compared to \ref page_whatsnew_V2018_08 "v2018.08" include:
<ul>
<li> new: CMake-base build, which deprecated the QMake-build</li>
<li> new: added QMake-Projects for static and for shared library builds </li>
<li> new: \ref exampleTutorialProjects "extensive set of Examples and Tutorials" </li>
<li> new: checked builds with continuous integration from AppVeyor: <a href="https://ci.appveyor.com/project/jkriege2/jkqtplotter/branch/master">https://ci.appveyor.com/project/jkriege2/jkqtplotter/branch/master</a> </li>