Skip to content

Commit

Permalink
Update DEVELOPMENT.md
Browse files Browse the repository at this point in the history
  • Loading branch information
carsonip committed Jun 7, 2021
1 parent e0acae8 commit 5112bb5
Showing 1 changed file with 11 additions and 20 deletions.
31 changes: 11 additions & 20 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## Introduction

Penguin Subtitle Player is a Qt5 project.

## Building

#### 1. Clone the project & download dependencies
Expand All @@ -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.
Expand All @@ -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!
Expand Down

0 comments on commit 5112bb5

Please sign in to comment.