Contributor Install Instructions

These instructions are for readers who want to improve Fontknife by

  1. Fixing bugs

  2. Adding new features

  3. Testing or reviewing the above

See User Install Instructions if you only want to convert files.

Requirements

First, make sure you have the following:

  1. A GitHub account

  2. Python 3.8+

  3. At least 5 MB of disk space to install dependencies

Install Instructions

  1. Fork the fontknife repo on GitHub

  2. Clone your fork

  3. cd fontknife to enter the directory

  4. Create a virtual environment

  5. Activate the virtual environment

  6. Run pip install fontknife -e .[dev,docs] to install the project and its dependencies in editable mode.

  7. Run fontknife convert --help to make sure it runs.

  8. Run pytest to run all unit tests.