ScStw/shared-libraries
ScStw/shared-libraries
Archived
2
0
Fork 0
Code Issues 5 Pull requests Projects Releases Packages Wiki Activity

add installation instructions

Browse source
This commit is contained in:
Dorian Zedler 2020-04-08 18:53:26 +02:00
parent f17eed6a96
commit e9971cab79
Signed by: dorian
GPG key ID: 989DE36109AFA354
1 changed files with 27 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
ScStwLibraries/ScStw.hpp
View file

@ -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
*/
/**