aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 3be68e103da6defbe8b40c813e15c01e9ed7cfd4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# TruFont [![Build Status](https://travis-ci.org/trufont/trufont.svg)](https://travis-ci.org/trufont/trufont)

![fontView Window](misc/fontView.png)

TruFont is a font-editing application written with Python3, ufoLib, defcon and
PyQt5.

## Getting started

1. Install dependencies with `pip install -r requirements.txt`

2. Install using `python setup.py install && trufont` or run under virtualenv:
   `cd Lib && python -m defconQt`

## Dependencies

Dependencies can be fetched with `pip install -r requirements.txt`

- Python 3
- PyQt5
- [fontTools]
- [ufoLib]
- [defcon, python3-ufo3 branch]
- cython & [booleanOperations]

Optional:

- [extractor, python3-ufo3 branch]
- [ufo2fdk, python3-ufo3 branch]

## Install notes

- On OSX, it is highly recommended to install all dependencies with [Homebrew]
  in order to have a correct Qt namespace (`brew` handles it all by itself).  
  Finish with `brew linkapps python3` to be able to call `python3` from the
  Terminal.
- You can have multiple versions of Python on your system, then you just need to
  use a version prefix, e.g.:
  * `python3`
  * `python3.4`
  * `python3.5`
  * …

[fontTools]: https://github.com/behdad/fonttools
[ufoLib]: https://github.com/unified-font-object/ufoLib
[defcon, python3-ufo3 branch]: https://github.com/trufont/defcon
[booleanOperations]: https://github.com/trufont/booleanOperations
[extractor, python3-ufo3 branch]: https://github.com/trufont/extractor
[ufo2fdk, python3-ufo3 branch]: https://github.com/trufont/ufo2fdk
[Homebrew]: http://brew.sh/