Skip to main content

Installation methods

Besides the base requirements, these methods can optionally depend on git and/or using a virtualenv
If you have multiple python applications on your system, using a virtualenv is **highly** recommended.

Git Installation​

  1. Open up a command prompt/shell.
  2. If the directory does not exist in the location where you want the program files to be located, create it.
  3. Clone the chosen repository into the given directory once you've changed into the directory:
    • stable - git clone -b stable git@github.com:MylarComics/mylar3.git
    • development - git clone -b nightly git@github.com:MylarComics/mylar3.git
  4. See install requirements

Source Installation (Unsupported)​

This is a legacy install method that we don't recommend as it makes it harder to manage cleaning up files with upgrades. If you really must follow this method, you're on your own for solving upgrade problems.

  1. Download the zip of the desired source branch (stable / nightly):
  2. Unpack in the directory of your choice
  3. See install requirements

Installation requirements​

From a command prompt/shell, change directory into the mylar installation.

Install the requirements with pip pip3 install -r requirements.txt

REMINDER: If you upgrade your Python version and are not managing a virtualenv to keep it static for mylar, you may need to reinstall requirements.

WINDOWS USERS - If the above fails, run py -m pip install -r requirements.txt.

Done. What now?​

See the starting instructions!