Development

Linux

1. Install Potrace using apt

sudo apt-get install potrace

1. 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/

1. Clone the repository or your fork

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

1. Install uv.

2. In the project directory, create the environment and install the project:

uv sync --all-groups

1. Make sure the tests run:

uv run python -m unittest discover

1. Install pre-commit hooks before contributing:

uv run 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/yashlamba/handwrite

1. Install uv.

2. In the project directory, create the environment and install the project:

uv sync --all-groups

1. Make sure the tests run:

uv run python -m unittest discover

1. Install pre-commit hooks before contributing:

uv run pre-commit install

You are ready to go!

Setting Up Docs

1. Install the documentation dependencies:

uv sync --group docs

1. Check the installations by executing this command:

uv run mkdocs --version

!!! warning ""
    If this doesn't work, try restarting the terminal

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

uv run 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.

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