Development

Linux

1. Install Potrace using apt

   sudo apt-get install potrace
   

2. Install fontforge

   sudo apt-get install fontforge
   

   Warning

   Since the PPA for fontforge is no longer maintained, apt might not work for some users. The preferred way to install is using the AppImage from: https://fontforge.org/en-US/downloads/

3. Clone the repository or your fork

   git clone https://github.com/builtree/handwrite
   

4. (Optional) Make a virtual environment and activate it

   python -m venv .venv
   source .venv/bin/activate
   

5. In the project directory run:

   pip install -e .[dev]
   

6. Make sure the tests run:

   python setup.py test
   

7. Install pre-commit hooks before contributing:

   pre-commit install
   

You are ready to go!

Windows

1. Install Potrace and make sure it's in your PATH.

2. Install fontforge and make sure scripting is enabled.

3. Clone the repository or your fork

   git clone https://github.com/builtree/handwrite
   

4. (Optional) Make a virtual environment and activate it

   python -m venv .venv
   .venv\Scripts\activate
   

5. In the project directory run:

   pip install -e .[dev]
   

6. Make sure the tests run:

   python setup.py test
   

7. Install pre-commit hooks before contributing:

   pre-commit install
   

You are ready to go!

Setting Up Docs

1. If you haven't done a developer install of handwrite, you will need to install mkdocs and its requirements:

   pip install mkdocs pymdown-extensions mkdocs-material mkdocs-git-revision-date-localized-plugin
   

2. Check the installations by executing this command:

   mkdocs --version
   

   If this doesn't work, try restarting the terminal

3. Use the below command to host the documentation on local server

   mkdocs serve --dev-addr 127.0.0.1:8000
   

   MkDocs supports live reload so you don't have to run the server again and again. Just save the changes in the docs and you'll see the change immediately.

4. All the documentation is present in the docs directory.