pianobooster/BUILD.md

71 lines
2.6 KiB
Markdown
Raw Normal View History

2019-06-05 05:03:40 +02:00
# Linux
Ensure that the following packages 'cmake', 'libqt5-dev', 'libasound2-dev' and
'build-essential" are installed.
Then type "cmake .", followed by "make". Finally as root type "make install".
2019-06-13 07:55:18 +02:00
(The pianobooster binary executable is now in the "build" subdirectory.)
2019-06-05 05:03:40 +02:00
To build a debug version create a dir called "debug" and change to that dir and then
type "cmake -DCMAKE_BUILD_TYPE=Debug .."
(Alternatively you can use qmake followed by make in the src directory.)
2019-06-11 00:12:58 +02:00
See [Debian branch](https://github.com/captnfab/PianoBooster/tree/debian) for more details.
2019-06-13 07:55:18 +02:00
See [Mageia Linux spec file ](pianobooster.spec) for more details.
2019-06-11 00:03:14 +02:00
If you make changes to the source code then please post details.
2019-06-05 05:03:40 +02:00
# macOS
2019-06-13 07:55:18 +02:00
Install latest Xcode (from Apple Developer Connection, free registration required).
2019-06-05 05:03:40 +02:00
Install CMake and QT libraries via Homebrew:
```
$ brew install cmake qt5
```
Generate XCode project file via CMake:
```
$ cmake -G Xcode . -DCMAKE_PREFIX_PATH=$(brew --prefix qt)`
```
Open the project file in XCode, set whatever options you like (universal or single architecture,
2019-06-13 07:55:18 +02:00
debug or release etc.) and compile.
2019-06-05 05:03:40 +02:00
2019-06-13 07:55:18 +02:00
To make a self contained application bundle use QT's macdeployqt tool (included in QT 4.5.0).
2019-06-05 05:03:40 +02:00
2019-06-11 00:03:14 +02:00
If you make changes to the source code then please post details.
2019-06-05 05:03:40 +02:00
# Windows
To compile in Windows install the Open Source version of Qt and CMake and optionally Geany.
When installing Qt select the option to download and install the MinGW compiler. Open the
Qt Command Prompt and then change to the "PianoBooster" directory and then type the
command below.
"C:\Program Files\CMake 2.6\bin\cmake.exe" -G "MinGW Makefiles" .
Once this is completed type "make".
2019-06-13 07:55:18 +02:00
Or alternatively you can install QtCreator and then open the pianobooster.pro
2019-06-05 05:03:40 +02:00
2019-06-11 00:03:14 +02:00
If you make changes to the source code then please post details.
2019-06-05 05:03:40 +02:00
# License
Piano Booster is fully copyrighted by the author and all rights are reserved.
PianoBooster is free software (Open Source software): you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later version.
PianoBooster is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License in the file "gplv3.txt" or from the web site
2019-06-06 09:22:50 +02:00
<http://www.gnu.org/licenses/> or [gplv3.txt](gplv3.txt).