Update readme file
This commit is contained in:
parent
76bad3a28d
commit
9afd07dc17
44
README.md
44
README.md
@ -1,40 +1,48 @@
|
|||||||
# mea
|
# nymea-app
|
||||||
|
|
||||||
QtQuick nymea client application
|
QtQuick nymea client application
|
||||||
|
|
||||||
# building
|
# building
|
||||||
|
|
||||||
Required packages:
|
Required packages:
|
||||||
It is recommended to install a complete Qt installation. Minimum required Version 5.7.
|
It is recommended to install a complete Qt installation. Minimum required Qt Version *5.7.0*.
|
||||||
|
|
||||||
No extra modules are required for a basic desktop build.
|
No extra modules are required for a basic desktop build.
|
||||||
|
|
||||||
After cloning the repository, run
|
After cloning the repository, run
|
||||||
|
|
||||||
$ git submodule init
|
$ git submodule init
|
||||||
$ git submodule update
|
$ git submodule update
|
||||||
|
|
||||||
To build a binary run
|
To build a binary run
|
||||||
$ mkdir builddir
|
|
||||||
$ cd builddir
|
|
||||||
$ qmake path/to/source/dir
|
|
||||||
$ make
|
|
||||||
|
|
||||||
Or open mea.pro in QtCreator and click the "Play" button.
|
$ mkdir builddir
|
||||||
|
$ cd builddir
|
||||||
|
$ qmake path/to/source/dir
|
||||||
|
$ make
|
||||||
|
|
||||||
|
Or open `nymea-app.pro` in QtCreator and click the **"Play"** button.
|
||||||
|
|
||||||
Optional configuration flags to be passed to qmake:
|
Optional configuration flags to be passed to qmake:
|
||||||
- CONFIG+=withtests
|
|
||||||
Enables building the testrunner target
|
|
||||||
|
|
||||||
Notes for Android:
|
- `CONFIG+=withtests`
|
||||||
|
|
||||||
|
> Enables building the testrunner target
|
||||||
|
|
||||||
|
## Android
|
||||||
As Qt can't bundle a build of openssl for android, you need to place a copy to
|
As Qt can't bundle a build of openssl for android, you need to place a copy to
|
||||||
/opt/android-ssl/
|
`/opt/android-ssl/`
|
||||||
|
|
||||||
|
## Windows
|
||||||
|
|
||||||
Notes for Windows:
|
|
||||||
There is an additional make target named "wininstaller" available. You need to
|
There is an additional make target named "wininstaller" available. You need to
|
||||||
have windeployqt and binarycreator (from Qt Install Framework 3.0) in your
|
have windeployqt and binarycreator (from Qt Install Framework 3.0) in your
|
||||||
system's Path.
|
system's Path.
|
||||||
|
|
||||||
# running the tests
|
# Running the tests
|
||||||
Required Packages:
|
|
||||||
- qtdeclarative5-test-plugin
|
Required Packages:
|
||||||
- nymead
|
|
||||||
|
- `qtdeclarative5-test-plugin`
|
||||||
|
- `nymead`
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user