add installation instructions
This commit is contained in:
parent
f17eed6a96
commit
e9971cab79
1 changed files with 27 additions and 3 deletions
|
@ -9,10 +9,34 @@
|
|||
*
|
||||
* @section intro_sec Introduction
|
||||
*
|
||||
* This is the Introduction
|
||||
* This library is meant for usage with the Speed climbing stopwatch project.
|
||||
* It contains some helper classes to build a client application for the ScStw basestation with Qt.
|
||||
*
|
||||
* @section section install_sec Installation
|
||||
* @subsection step1 Step 1: Opening the box
|
||||
* @section section Installation
|
||||
* @code{.sh}
|
||||
* cd yourRepo
|
||||
* git submodule add https://git.itsblue.de/ScStw/shared-libraries/
|
||||
* git submodule update --init --recursive
|
||||
* @endcode
|
||||
*
|
||||
* Add to the list of libraries for the Qt-Secret assembly. For an example you can create Main.Pro in which connect Qt-Secret and your project.pro files as subprojects.
|
||||
*
|
||||
* Main.pro:
|
||||
* @code{.pro}
|
||||
* TEMPLATE = subdirs
|
||||
* CONFIG += ordered
|
||||
*
|
||||
* SUBDIRS += \
|
||||
* ScStwLibraries \
|
||||
* MyProject
|
||||
*
|
||||
* ScStwLibraries.file = shared-libraries/ScStwLibraries/ScStwLibraries.pro
|
||||
* @endcode
|
||||
*
|
||||
* And in your MyProject.pro include the .pri file
|
||||
* @code{.pro}
|
||||
* include($$PWD/../shared-libraries/ScStwLibraries/ScStwLibraries.pri)
|
||||
* @endcode
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
Reference in a new issue