Run Manuskript from Source Code on Windows

SUMMARY

This guide describes the steps for installing and running Manuskript from source code on Windows.

The steps include installing all necessary software dependencies.

These steps were developed on Windows XP and also tested on Windows 7. The steps should work as is or as a guideline for newer version of Windows.

Text based commands in this guide should be run in a command prompt.

Open Command Prompt

Following are some ways to invoke a terminal session with different versions of Windows:

• Use menu option Start -> All Programs -> Accessories -> Command Prompt
• Press Windows Key + R on keyboard to open launcher, type cmd.exe and press Enter key.

INSTALLATION

Install Required Software Packages

Manuskript is written in the Python (v3) programming language and uses the QT (v5) cross-platform UI framework and also requires some additional software.

Download and install the following software:

Python v3.x

Download Python v3.4.4 - Windows MSI x86 installer and run the installer accepting all defaults.
https://www.python.org/downloads/windows/
Python v3.4.4 is the last version that works with Windows XP.

PyQT v5.x

Download PyQt v5.5.1 for python v3.4 Windows 32 bit installer and run the installer accepting all defaults.
https://sourceforge.net/projects/pyqt/files/PyQt5/
PyQt v5.5.1 is the last version that works with Windows XP and Python v3.4.x

Note that 64 bit versions and newer versions are available from
https://www.riverbankcomputing.com/software/pyqt/download5

LXML

Download lxml-3.4.4.win32-py3.4.exe and run the installer accepting all defaults.
https://pypi.python.org/pypi/lxml/3.4.4/

PyEnchant (Optional - spell checker)

1. Open a command prompt as described earlier.

2. Change to the C:\Python34\Scripts directory.

   C:
   cd \Python34\Scripts
   

3. Install PyEnchant using pip.

   pip install pyenchant
   

   At time of writing v1.6.8 was installed. You can specify this version with the pip install pyenchant==1.6.8 command.

4. Close command prompt.

Install Git and Manuskript

The source code for Manuskript is managed with the git distributed version control system, and hence we need git to be able to clone a copy of the source code.

Install Git

Download Git-v2.10.0-32-bit.exe and run the installer accepting all defaults.
https://github.com/git-for-windows/git/releases/tag/v2.10.0.windows.1
Git v2.10.0 is the last version to support Windows XP.

Download Manuskript Source Code

1. Open a command prompt as described earlier.

2. Choose and change to a directory to install the source code. For example, your C:\ directory:

   C:
   cd \
   

3. Use git to clone a copy of the source code your chosen directory.

   git clone https://github.com/olivierkes/manuskript.git
   

   The above command will create a manuskript subdirectory.

4. Change into the manuskript subdirectory.

   cd manuskript
   

At any time after you have cloned the source code, you can update your copy to the latest version with the git pull command.

Optional: Switch to the develop Branch (latest unreleased version)

git checkout develop

Note that you can return to the master branch with the git checkout master command.

EXCECUTION

Run manuskript from Source Code

Enter the following command in a command prompt, or Win+R launcher:

C:\Python34\python "C:\manuskript\bin\manuskript"

Note that the above command requires the full directory path to the location in which you installed manuskript.