diff --git a/src/windows/README.txt b/src/windows/README.txt index be62beacd..b2e03f8b0 100644 --- a/src/windows/README.txt +++ b/src/windows/README.txt @@ -1,42 +1,61 @@ +TRANSLATORS: + +1. Use an editor that has NSIS syntax highlighting(eg Geany). This will + make your life easier. +2. Open the relevant .nsi file that exists in the folder named + "installer-translations" +3. Lines starting with ";" are considered comments. These include the + english message to help you with the translation. +4. Edit only the part inside the quotation marks(""). Unless you know + what you are doing. +5. Submit your changes: 1) as a pull request to the official git repo or + 2) open an issue to the bugtracker and attach them or 3) via email or + 4)the same way you provide the tranlations for qbt itself + +PACKAGERS: + You will need NSIS and upx to make the installer. -Open the qbittorrent.nsi file in an editor and change line that contains "!define PROG_VERSION "3.0.3"" to the version of qbittorrent you just built. +1. Open the options.nsi file in an editor and change line that contains + "!define PROG_VERSION "3.0.3"" to the version of qbittorrent you just built. +2. Extract the plugins found in the folder "nsis plugins" into the your + NSIS's Plugin directory(usually C:\Program Files\NSIS\Plugins). + Only the *.dll files are needed. +3. The script you need to compile is "qbittorrent.nsi". It includes all other necessary scripts. +4. The script expects the following file tree: The installer script expects the following file tree: Root: +installer-translations + afrikaans.nsi + .... + (all the .nsi files found here in every source release) + welsh.nsi translations qt_ar.qm - qt_bg.qm - qt_ca.qm - qt_cs.qm - qt_da.qm - qt_de.qm - qt_es.qm - qt_fi.qm - qt_fr.qm - qt_gl.qm - qt_he.qm - qt_hu.qm - qt_it.qm - qt_ja.qm - qt_ko.qm - qt_lt.qm - qt_nl.qm - qt_pl.qm - qt_pt.qm - qt_pt_BR.qm - qt_ru.qm - qt_sk.qm - qt_sv.qm - qt_tr.qm - qt_uk.qm - qt_zh_CN.qm + ... + (all the .qm files found here in every source release) qt_zh_TW.qm +installer.nsi license.txt +options.nsi qbittorrent.exe qbittorrent.nsi qt.conf +translations.nsi +uninstaller.nsi + + +5. "license.txt" is a text file that contains the text rendered + from src\gpl.html or the text contained in COPYING +6. "qbittorrent.exe" is the compiled binary file. +SCRIPT HACKERS: -license.txt is a text file that contains the text rendered from src\gpl.html +If you add any new LangString variable to the scripts you NEED to provide +"translations" of it to all the .nsi files inside "installer-translations. +You can always leave the english string but you have to use all the LANG_ +for the given variable. Otherwise, if the user chooses a language that you +haven't provide a LANG_ for your variable then your string will be empty. +Don't worry though, NSIS throws warnings for this when compiling the scripts.