From ac59515994d6083fcde82e5a4dbcfea088c3c5f5 Mon Sep 17 00:00:00 2001 From: Rasim Labibov Date: Wed, 1 Nov 2017 12:00:39 +0200 Subject: [PATCH] Updated README. --- README.md | 62 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 46 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 0a780e6..e00d9be 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,76 @@ -# Minimal Qt QML Project +## Introduction -This is minimal program that uses Qt Qml for creating user interface library -and using CMake as build system. +This is minimal program that uses QtQuick library for creating user interface +and using CMake as build system. The application created is simple in design and +consists of sole window. ## Built With -* [CMake](http://cmake.org/) - Build system (>=5.7 is required). -* [Qt](http://www.qt.io/) - Cross-platform library (>=2.8 is required). +Compiling and running the project requires GCC, CMake, GNU Make +and Qt development libraries with Qt Quick enabled. -## Getting Started +* [CMake](http://cmake.org/) - Build system (>=2.8 is required). +* [Qt](http://www.qt.io/) - Cross-platform library (>=5.7 is required). + +## Dependencies Install the following packages to prepare the build. ### Ubuntu & Debian +The following instructions are appliable to: * Ubuntu 16.04 * Debian 9 ``` -sudo apt-get install -y build-essential cmake qtbase5-dev qtdeclarative5-dev qml-module-qtquick2 qtquickcontrols2-5-dev qml-module-qtquick-controls +sudo apt-get install -y \ + build-essential \ + cmake qtbase5-dev \ + qtdeclarative5-dev \ + qml-module-qtquick2 \ + qtquickcontrols2-5-dev \ + qml-module-qtquick-controls ``` -### Fedora & CentOS - -* CentOS 7 -* Fedora >=20 +### CentOS 7 ``` sudo yum groupinstall -y "Development Tools" -sudo yum install -y cmake qt5-qtbase-devel qt5-qtdeclarative-devel qt5-qtquickcontrols qt5-qtquickcontrols2-devel +sudo yum install -y \ + cmake \ + qt5-qtbase-devel \ + qt5-qtdeclarative-devel \ + qt5-qtquickcontrols \ + qt5-qtquickcontrols2-devel ``` -### Build Solution +### Fedora >=22 + +``` +sudo dnf groupinstall -y "Development Tools" +sudo dnf install -y \ + cmake \ + qt5-qtbase-devel \ + qt5-qtdeclarative-devel \ + qt5-qtquickcontrols \ + qt5-qtquickcontrols2-devel +``` + +## Build Project Call the build of the solution and launch the application: ``` cd -mkdir build -cd build +mkdir build && cd build cmake .. make -./src/MinimalQml & +``` + +After building the binary `MinimalQml` will end up in `build/src/` + +``` +cd build/src +./MinimalQml ```