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 the plugins found in the folder "nsis plugins" into your
  25    NSIS's unicode Plugin directory(usually C:\Program Files\NSIS\Plugins\x86-unicode).
  26    Only the *.dll files are needed. Use the unicode version of the dlls.
  27 4. The script you need to compile is "qbittorrent.nsi". It includes all other necessary scripts.
  28 5. The script expects the following file tree:
  29
  30 The installer script expects the following file tree:
  31
  32 Root:
  33 installer-translations
  34         afrikaans.nsi
  35         ....
  36         (all the .nsi files found here in every source release)
  37         welsh.nsi
  38 translations
  39         qt_ar.qm
  40         ...
  41     (All the .qm files found in the 'translations' folder of your Qt install. Those files differ between Qt5 and Qt6.
  42      You will need the files that conform to this globbing expression 'qt_??.qm qt_??_??.qm qtbase_??.qm qtbase_??_??.qm'.
  43      Some of those files will be stubs. Filter any file that is smaller than 10KB in size.
  44      Alternatively you can use the 'gather_qt_translations.py' script found in the same folder as this file.
  45      Run it with '--help' to see its usage.)
  46         qt_zh_TW.qm
  47 installer.nsi
  48 license.txt
  49 config.nsi
  50 helper.nsi
  51 qbittorrent.exe
  52 qbittorrent.pdb
  53 qbittorrent.nsi
  54 qt.conf
  55 translations.nsi
  56 UAC.nsh
  57 uninstaller.nsi
  58
  59
  60 6. "license.txt" is a text file that contains the text rendered
  61    from src\gui\gpl.html
  62 7. "qbittorrent.exe" is the compiled binary file.
  63 8. "qbittorrent.pdb" is the compiled binary's PDB file.
  64
  65 SCRIPT HACKERS:
  66
  67 If you add any new LangString variable to the scripts you NEED to provide
  68 "translations" of it to all the .nsi files inside "installer-translations.
  69 You can always leave the english string but you have to use all the LANG_<lang name>
  70 for the given variable. Otherwise, if the user chooses a language that you
  71 haven't provided a LANG_<lang name> for your variable then your string will be empty.
  72 Don't worry though, NSIS throws warnings for this when compiling the scripts.