From 521c875556d4062ff4a8c7146ed094d8113306b1 Mon Sep 17 00:00:00 2001 From: Daniel Teichmann Date: Sat, 1 Aug 2020 01:40:32 +0200 Subject: Update README.md: Add build documentation --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 46 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a452022..72ef5c9 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,58 @@ This is a remote-support App for the desktop using Qt Quick / QML. +Building project +---------------- + +### Install dependencies + +`sudo apt install qt5-default qmlscene build-essential + libgles2-mesa-dev qtquickcontrols2-5-dev qtdeclarative5-dev + qml-module-qtquick-controls2 qml-module-qtquick-dialogs + qml-module-qtquick-extras` + + +### Cross compiling +To cross compile from linux to windows for example please look at this source + +https://stackoverflow.com/questions/10934683/how-do-i-configure-qt-for-cross-compilation-from-linux-to-windows-target + +### Clone this repo + +`git clone + https://gitlab.das-netzwerkteam.de/remotewebapp/remote-support-desktop.git` + +### Making of Makefile + +1. `cd remote-support-desktop && mkdir BUILD && cd BUILD` + +2. `qmake ../remote-support-desktop.pro` + +qmake should have made a `Makefile` now which can be used by `make` to build an executable + +### Using Makefile to build project + +1. `make` + +### Test your new executable + +1. `./remote-support-desktop` + + Installation of dev-environment ------------------------------- ### Clone this repo -`git clone https://gitlab.das-netzwerkteam.de/remotewebapp/remote-support-desktop.git` +`git clone + https://gitlab.das-netzwerkteam.de/remotewebapp/remote-support-desktop.git` ### Install Qt Creator and necessary packages -`sudo apt install qtcreator qt5-default qmlscene build-essential libgles2-mesa-dev qtquickcontrols2-5-dev qtdeclarative5-dev qml-module-qtquick-controls2 qml-module-qtquick-dialogs qml-module-qtquick-extras` +`sudo apt install qtcreator qt5-default qmlscene build-essential + libgles2-mesa-dev qtquickcontrols2-5-dev qtdeclarative5-dev + qml-module-qtquick-controls2 qml-module-qtquick-dialogs + qml-module-qtquick-extras` ### Import the project into Qt Creator @@ -28,7 +70,8 @@ Installation of dev-environment 1. Try pressing CTRL and R (Building and running the project) -2. If Qt Creator asks for an executable file in a dialog box proceed with next step +2. If Qt Creator asks for an executable file in a dialog box proceed with + next step ### Run settings @@ -43,4 +86,3 @@ Installation of dev-environment 5. (Make sure that you tried to build the project at least once, or else the folder won't exist yet) ### Profit - -- cgit v1.2.3