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 32 bit Windows XP and also tested on 64 bit Windows 7 (see also Appendix A near bottom). 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 command prompt in Windows:

Use menu option Start -> All Programs -> Accessories -> Command Prompt
Simultaneously press Windows + R keys 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 x86 MSI 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)

Open a command prompt as described earlier.
Change to the C:\Python34\Scripts directory.
```
C:
cd \Python34\Scripts
```
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.
Close command prompt.

At time of writing the following dictionaries were automatically installed with PyEnchant: de_DE, en_AU, en_GB, en_US, and fr_FR.

MarkDown (Optional - provides Manuskript export as HTML)

Use steps similar to those above to install PyEnchant.

Install MarkDown using pip.
```
pip install markdown
```
At time of writing v2.6.8 was installed. You can specify this version with the pip install markdown==2.6.8 command.

Pandoc (Optional - provides more Compile/Export formats)

To access additional compile/export formats, such as ePub, OpenDocument and DocX, download and install pandoc.

At time of writing pandoc v1.19.2.1 was installed.

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

Open a command prompt as described earlier.
Choose and change to a directory to install the source code. For example, your C:\ directory:
```
C:
cd \
```
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.
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