From 5112bb55a3e8932fc4d102a2d223f1256646d454 Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Mon, 7 Jun 2021 23:32:50 +0100 Subject: [PATCH] Update DEVELOPMENT.md --- DEVELOPMENT.md | 31 +++++++++++-------------------- 1 file changed, 11 insertions(+), 20 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index d9e3b8d..31b233b 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -1,3 +1,7 @@ +## Introduction + +Penguin Subtitle Player is a Qt5 project. + ## Building #### 1. Clone the project & download dependencies @@ -20,31 +24,24 @@ Use one of the following ways: 1. Download Qt with Qt Creator [here](http://www.qt.io/download-open-source/) 2. Open the .pro file in Qt Creator -3. You should be good to go (In case of some weird compilation errors, turn off the shadow build option in projects build settings) +3. Click on "Build" ##### b. The hard way (Command line) -1. Download Qt (Qt Creator is not required) [here](http://www.qt.io/download-open-source/) +1. Download Qt (without Qt Creator) [here](http://www.qt.io/download-open-source/) 2. Run qmake ``` qmake PenguinSubtitlePlayer.pro ``` 3. Build from the makefile generated by qmake - * G++ (Linux, macOS): ```make``` - * VC++ (Windows): ```nmake``` - * MinGW (Windows): ```mingw32-make``` + * G++, Clang: ```make``` + * MSVC: ```nmake``` 4. You should see the executable under ```build/debug``` or ```build/release``` -In case you would like to deploy a version which does not require Qt libraries in the client's system, consider statically build Qt then `qmake` with the `static` option, or change the config line in `PenguinSubtitlePlayer.pro` to -``` -CONFIG += static \ - c++11 -``` +To deploy a static build, build Qt statically and run `qmake "CONFIG+=static" PenguinSubtitlePlayer.pro`. ## Developing -Penguin Subtitle Player is a Qt5 project. The executables include statically compiled Qt libraries. - #### Code formatting This project uses [ClangFormat](https://clang.llvm.org/docs/ClangFormat.html) version 7 or higher. @@ -58,22 +55,16 @@ find . -path "./src/uchardet" -prune -o \( -name '*.h' -o -name '*.cpp' \) -prin #### Libraries * [uchardet](https://gitlab.freedesktop.org/uchardet/uchardet): Encoding detector -#### Compilers - -* Windows: VC++ 2012 -* Linux: G++ -* macOS: G++ +#### Deployment Check [here](http://doc.qt.io/qt-5/deployment.html) for deployment details. ## Testing 1. Run `qmake "CONFIG+=test" PenguinSubtitlePlayer.pro` -2. Build from the makefile as described in the Building part +2. Build from the makefile 3. Run the executable -Note: This project is using [TravisCI](https://travis-ci.com/github/carsonip/Penguin-Subtitle-Player) for testing. - ## Contributing 1. Fork it!