Add an option to set BitTorrent session shutdown timeout
[qBittorrent.git] / INSTALL
blob86ed7c5f3827b8d2e423b99b2723ff2a7508d1bc
1 qBittorrent - A BitTorrent client in C++ / Qt
2 ------------------------------------------
4 1) Install these dependencies:
6   - Boost >= 1.76
8   - libtorrent-rasterbar 1.2.19 - 1.2.x || 2.0.10 - 2.0.x
9       * By Arvid Norberg, https://www.libtorrent.org/
10       * Be careful: another library (the one used by rTorrent) uses a similar name
12   - OpenSSL >= 3.0.2
14   - Qt 6.5.0 - 6.x
16   - zlib >= 1.2.11
18   - CMake >= 3.16
19       * Compile-time only
21   - Python >= 3.7.0
22       * Optional, run-time only
23       * Used by the bundled search engine
25 Dependency version numbers are bumped every once in a while to keep the range of properly tested configurations manageable, even if not strictly required to build.
26 You may be able to build with older versions of (some of) the dependencies other than the minimum versions specified in the build scripts, but support for such builds is not provided - you are on your own.
27 Please ensure you are building with an officially supported configuration when reporting bugs.
29 2a) Compile and install qBittorrent with Qt graphical interface
31   $ cmake -B build -DCMAKE_BUILD_TYPE=Release
32   $ cmake --build build
33   $ cmake --install build
34   $ qbittorrent
36   will install and execute qBittorrent.
38 2b) Compile and install qBittorrent without Qt graphical interface
40   $ cmake -B build -DCMAKE_BUILD_TYPE=Release -DGUI=OFF
41   $ cmake --build build
42   $ cmake --install build
43   $ qbittorrent-nox
45   will install and execute qBittorrent.
47 DOCUMENTATION:
48 Please note that there is a "Compilation" section at https://wiki.qbittorrent.org.
50 ------------------------------------------
51 sledgehammer999 <sledgehammer999@qbittorrent.org>