https://github.com/trufont/trufont

TruFont is a streamlined and hackable font editor. À l’ancienne.
https://github.com/trufont/trufont

desktop fonts vector-graphics

Last synced: about 1 month ago
JSON representation

TruFont is a streamlined and hackable font editor. À l’ancienne.

• Host: GitHub
• URL: https://github.com/trufont/trufont
• Owner: trufont
• License: other
• Created: 2015-10-11T20:32:11.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-06-24T21:50:46.000Z (over 1 year ago)
• Last Synced: 2024-10-02T08:00:06.083Z (2 months ago)
• Topics: desktop, fonts, vector-graphics
• Language: Python
• Homepage: http://trufont.github.io/
• Size: 2.29 MB
• Stars: 481
• Watchers: 34
• Forks: 57
• Open Issues: 97
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.GPLv3

Awesome Lists containing this project

• awesome-typography - TruFont - UFO3 font editor. À l’ancienne. (Tools with GUI / Free)
• awesome-starred - trufont/trufont - TruFont is a streamlined and hackable font editor. À l’ancienne. (others)

README

        


# TruFont

**Multi-platform UFO font editor**

[![Build status](https://travis-ci.org/trufont/trufont.svg?branch=master)](https://travis-ci.org/trufont/trufont)



**Maintenance status:** The trufont project is currently discontinued.

Although we will happily accept bug fixes, no new features are currently

planned.

[TruFont](https://trufont.github.io) is a multiplatform font editor

built with Python3 and PyQt5.

The `wx` branch contains a stub wxWidgets port of the app.

## Getting started

1.  Install **Python 3.6** (or later):

    -   OS X: Install using [Homebrew](http://brew.sh/):

        `brew install python3`

    -   Windows: Download installer from

        [python.org/downloads](https://www.python.org/downloads/)

    -   Linux: It's usually packaged with the OS.

2.  Set up a new Python **virtual environment**. Although this is not

    required, it's *highly recommended*, since TruFont has lots of

    dependencies, which may (or may not) conflict with other modules you

    installed globally.

    -   To create a new virtual environment in `ENV_DIR`:

        `python3 -m venv ENV_DIR`

        This creates a new `ENV_DIR` folder (you can choose the name you

        want). The `bin` subfolder (or `Scripts` if you are on Windows)

        contains a new `python` executable, and the `pip` installer

        linked to that.

    -   Activate the newly created environment:

        -   OS X or Linux: `source ENV_DIR/bin/activate`

        -   Windows: `ENV_DIR\Scripts\activate.bat`

        This temporarily adds the virtual environment's scripts folder

        to your console's `PATH`, so you can access `python`, `pip` and

        the `trufont` script from anywhere.

    -   Run `deactivate` when you wish to exit the virtual environment.

        This restores the default system `PATH`.

3.  Install/update TruFont to the latest stable release:

    `pip install --upgrade trufont`

4.  Run the app as `trufont`.

## Contributing

Here's a quick tutorial if you'd like to contribute to TruFont.

1.  Click the "Fork" button above, and clone the forked git repository

    to a new directory called `trufont`:

    `git clone https://github.com//trufont`

2.  Move into the new folder and run this command to add the upstream

    repository url to the local list of remotes:

    `git remote add upstream https://github.com/trufont/trufont`

    This enables you to keep up-to-date with the upstream development.

3.  Synchronize your fork's `master` branch

    with the `upstream/master`, especially before creating new branches:

    ``` 

    git checkout master

    git fetch upstream

    git rebase upstream/master

    git push

    ```

4.  Install pre-commit. It will run some checks every time you are about

    to commit something.

    ``` 

    pip install pre-commit

    pre-commit install

    ```

5.  Now, you can create and checkout your new feature branch:

    `git checkout -b my-cool-new-feature`

6.  Use pip to install TruFont in "editable" mode:

    `pip install --editable .`

    Instead of copying `trufont` to your

    Python site-packages directory, this command only creates a link to

    the source directory inside the git repository. You can then modify

    the code in place, or synchronize the latest upstream changes (as in

    step 4) without having to re-install.

7.  It is also recommended to regularly update the dependencies to the

    curently tested versions as listed in \`requirements.txt\`:

    `pip install --upgrade -r requirements.txt`

8.  Once you have commited your patch, push the new branch to your fork:

    `git push -u origin my-cool-new-feature`

9.  Finally, click "New pull request" on TruFont's GitHub page to submit

    your patch.