dist/windows/README.txt

   1 TRANSLATORS:
   2
   3 1. Use an editor that has NSIS syntax highlighting(eg Notepad++/Geany). This will
   4    make your life easier.
   5 2. Open the relevant .nsi file that exists in the folder named
   6    "installer-translations"
   7 3. Lines starting with ";" are considered comments. These include the
   8    english message to help you with the translation.
   9 4. Edit only the part inside the quotation marks(""). Unless you know
  10    what you are doing.
  11 5. Save the files with UTF-8 encoding, without BOM
  12    (this should be the default in any modern text editor).
  13 6. Submit your changes: 1) as a pull request to the official git repo or
  14    2) open an issue to the bugtracker and attach them or 3) via email or
  15    4)the same way you provide the translations for qbt itself
  16
  17 PACKAGERS:
  18
  19 You will need NSIS 3 to make the installer. UPX is an optional requirement.
  20
  21 1. Open the config.nsi file in an editor and change line that contains
  22    "!define QBT_VERSION "3.0.3"" to the version of qbittorrent you just built.
  23 2. config.nsi contains some other defines that control the installer output. Read the comments in that file.
  24 3. Extract "NSISPlugins.zip" next to "qbittorrent.nsi" script or into your
  25    NSIS's unicode Plugin directory (usually "C:\Program Files\NSIS\Plugins\x86-unicode").
  26 4. The script you need to compile is "qbittorrent.nsi". It includes all other necessary scripts.
  27 5. The script expects the following file tree:
  28
  29 installer-translations
  30     afrikaans.nsh
  31     ....
  32     (all the .nsh files found here in every source release)
  33     welsh.nsh
  34 installer.nsh
  35 license.txt
  36 config.nsh
  37 qbittorrent.nsi
  38 qt.conf
  39 translations.nsh
  40 UAC.nsh
  41 uninstaller.nsh
  42 qBittorrent
  43     qbittorrent.exe (required)
  44     qbittorrent.pdb (optional but recommended)
  45     translations (optional)
  46         qt_ar.qm
  47         ..
  48         (All the .qm files found in the 'translations' folder of your Qt install. Those files differ between Qt5 and Qt6.
  49          You will need the files that conform to this globbing expression 'qt_??.qm qt_??_??.qm qtbase_??.qm qtbase_??_??.qm'.
  50          Some of those files will be stubs. Filter any file that is smaller than 10KB in size.
  51          Alternatively you can use the 'gather_qt_translations.py' script found in the same folder as this file.
  52          Run it with '--help' to see its usage.)
  53         qt_zh_TW.qm
  54     (Any other files including the ones from all subdirectories will be also included in the installer.)
  55
  56 6. "qbittorrent.exe" is the compiled binary file.
  57 7. "qbittorrent.pdb" is the compiled binary's PDB file.
  58
  59 SCRIPT HACKERS:
  60
  61 If you add any new LangString variable to the scripts you NEED to provide
  62 "translations" of it to all the .nsi files inside "installer-translations.
  63 You can always leave the english string but you have to use all the LANG_<lang name>
  64 for the given variable. Otherwise, if the user chooses a language that you
  65 haven't provided a LANG_<lang name> for your variable then your string will be empty.
  66 Don't worry though, NSIS throws warnings for this when compiling the scripts.