Kolibri Windows Installer

Repository for the Kolibri windows installer and launcher application

This project provides a smoother way to install and run Kolibri in a Windows Machine.

ATTENTION: this readme needs some updates. See issue #169 for additional assistance building the projects.

Steps for making Windows installer releases

These are the steps how to do releases for the Kolibri Windows installer. Note that this involves the kolibri repo.

We are releasing v1.3.1 as an example here.

1. Set the new version in KolibriSetupScript.iss where we set the KOLIBRI_INSTALLER_VERSION env var.
2. Tag the develop branch as v1.3.1 at kolibri-installer-windows
   1. Go to the releases page then Draft a new release.
   2. Put v1.3.1 as the tag and title for the release.
   3. Select develop as the target for the release.
   4. Add the features or fixes in the description.
   5. Click on the Publish release when done.
3. Make a Pull Request (PR) at the kolibri repo pointing to the appropriate branch (example: develop).
   1. In that PR, set the kolibri/docker/env.list/KOLIBRI_WINDOWS_INSTALLER_VERSION=v1.3.1 environment variable value. This points the Kolibri source into our v1.3.1 branch.
   2. Test the BuildKite built assets in that PR if no errors are encountered.
4. Merge the kolibri PR when tests for the Kolibri Windows installer passed.

Release history

See https://github.com/learningequality/kolibri-installer-windows/releases

Python versions

Installer release	Kolibri versions	Python
Untracked	<0.4.6	Python 2.7.10
1.0.0	0.4.6	Python 2.7.13
1.1.0	0.6.1	Python 2.7.13
1.1.1	0.7.1	Python 2.7.13
1.1.2	0.9.1	Python 2.7.13
1.2.0	0.10.x	Python 3.4.3
1.2.1	0.11.x,<=0.12.2	Python 3.4.3
1.3.0	0.12.3+	Python 3.4.3
1.3.1	0.12.5+	Python 3.4.3
1.3.2	0.12.6+	Python 3.4.3
1.3.3	0.12.8+	Python 3.4.3
1.3.4	0.12.9+	Python 3.4.3
1.3.5	0.13.0+	Python 3.4.3
1.3.6	0.13.0+	Python 3.4.3

---

This project was built using the following software:

• Windows 8.1 32/64bit or Windows 10 32/64bit
• Inno Setup 6.0.2 Unicode [Download] (http://files.jrsoftware.org/is/6/)
• Microsoft Visual Studio Community 2015 [Website] (https://www.visualstudio.com/)
• Git (Note: Install with the option to place the git executable in the path, so it can be run within cmd.)

---

Instructions to build the GUI:

1. Open gui-source/Kolibri.sln using Visual Studio.
2. Click on the Build menu and then choose the Build Solution option.
3. Copy the resulting Kolibri.exe from its output location to gui-packed/Kolibri.exe

Notes:

1. If you have made no changes to gui-source, you don't have to build Kolibri.exe, just use the version in this repo.
2. If you do make changes to anything in gui-source, be sure to build and commit Kolibri.exe.
3. There is an outstanding issue to "Remove the Kolibri.exe executable from the repo." to address this.

---

Instructions to build "kolibri-static":

1. Follow the steps to setup Kolibri.
2. In the command line, run the make dist command in /kolibri directory.
3. The output file named kolibri_static-x.x.x.devxxxx-py2.py3-none-any.whl will appear within the kolibri/dist project folder.

---

Instructions to build "KolibriSetup-*.exe" via Inno Setup:

1. Clone this repository;
2. Follow the Instructions to build "kolibri-static" and copy the kolibri\dist\kolibri_static-x.x.x-py2.py3-none-any.whl.file to this directory.
3. Run the following command from this directory:

   make.bat

4. The output file named "KolibriSetup-X.X.X.exe" will appear within this project folder.

---

Run the project using Inno Setup for Development:

1. Clone this repository.
2. Download and install Inno Setup from the above link.
3. Set the KOLIBRI_BUILD_VERSION environment variable. Example: "v0.12.6"
4. Copy the contents of the windows\inno-compiler\Languages\ folder into C:\Program Files (x86)\Inno Setup 5\Languages\ - these are *.isl files.
5. If you don't have a .whl file yet - download a .whl from the Kolibri releases page then copy it into the root of the repo folder. You may also follow the "Instructions to build "kolibri-static"" section.
6. Double-click the installer-source/KolibriSetupScript.iss file to open it in Inno Setup.
7. Press the Run button.

Note: Building is not supported/recommended in Windows 7. However, builds have been tested to work on an updated Windows 7.

---

Instructions to extract and encode translatable strings from Inno setup .isl file:

1. To extract the translable strings from the Inno setup .isl file into .po file:

   • At the /python-scripts directory run the extract-isl-strings.py
   • A sample command to run the script python extract-isl-string.py /xxx/xxx.isl
   • The agument .isl file can be found at this path inno-compiler/Default.isl
   • It will create a /kolibri-installer.po at this path /python-scripts.

2. To encode translated strings from .po into Inno setup .isl file.

   • At the /python-scripts directory run the encode-strings.py
   • A sample command to run the script python2.7 ./encode-strings.py /xxx/xxx.isl /xxxx/kolibri-installer.po
   • After the script ran it will ask for the language name, language id and language code page.
   • The output filename will be the specified language name.

---

To clone Kolibri and this repository, run the following lines:

• git clone https://github.com/mrpau/kolibri-installers.git
• git clone https://github.com/learningequality/kolibri.git

---

References:

Distribution and Installer http://kolibri.readthedocs.io/en/latest/dev/building.html