The Heir

He's running from responsibility. She's saving the world. They have thirty days to deal with what their families left in store for them

The Heir is an independent feature film in active development in 2018. In addition to what we hope is a compelling story, the project is an experiment in applying collaborative, agile methodologies to film.

You can read about the story, characters, cast and process on our Wiki site: https://github.com/arikrupnik/the-heir/wiki

This page describes the technical aspects of contributing to the project.

Installation on Windows

If you already have a Git environment on your Windows machine, you can skip this section. Clone our repository to your local drive, install Pandoc and Weasyprint you're ready to go.

If you've not worked with Git before, we recommend using Cygwin as your environment on Windows. In our experience, it is much easier to install the necessary utilities in Cygwin than alternatives.

1. Download and install https://www.cygwin.com/. During installation, select the following optional packages:
   • git
   • make
   • python2
   • python2-pip
   • aspell
   • aspell-en
   • libxml2
   • libxslt
   • libgtk2.0-devel
   • wget
   • unzip
2. In the new Cygwin shell, run the following commands:
   • pip2 install markdown
   • pip2 install weasyprint
   • wget https://github.com/jgm/pandoc/releases/download/2.1.3/pandoc-2.1.3-windows.zip
   • unzip -j -d /bin pandoc-2.1.3-windows.zip pandoc-2.1.3/pandoc.exe

Installation on MacOS

1. Download and install https://www.macports.org. Installation may require installing Apple's XCode or Xcode Command Line Tools. Follow MacPorts instructions for your version of MacOS.
2. In a terminal, run the following commands:
   • port install git gmake aspell python27 py27-pip aspell-dict-en libxml2 libxslt gtk2
   • pip27 install markdown
   • pip27 install weasyprint
   • echo 'export PATH=$PATH:/opt/local/Library/Frameworks/Python.framework/Versions/2.7/bin' >> ~/.profile
3. Download and install https://github.com/jgm/pandoc/releases/download/2.1.3/pandoc-2.1.3-macOS.pkg

Installation on Linux

We assume that you already have git and friends on your system. Please note that we use Python 2.7 and Gnu make. You need aspell, ibxml2-utils, xsltproc and pandoc; consult your package manager for specific installation commands. You need two Python libraries: pip install markdown weasyprint.

On all OSs

In a terminal, run the following commands:

• git clone https://github.com/arikrupnik/the-heir.git
• cd the-heir
• git submodule init
• git submodule update
• make

If everything succeded, you'll find the-heir.pdf and the-heir_treatment.pdf in the current directory.