https://github.com/source-foundry/ttfautohint-build
Build ttfautohint from source on Linux and macOS platforms
https://github.com/source-foundry/ttfautohint-build
Last synced: 11 months ago
JSON representation
Build ttfautohint from source on Linux and macOS platforms
- Host: GitHub
- URL: https://github.com/source-foundry/ttfautohint-build
- Owner: source-foundry
- License: mit
- Created: 2017-08-28T00:09:02.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-03-23T10:06:36.000Z (about 4 years ago)
- Last Synced: 2025-04-05T00:51:17.756Z (12 months ago)
- Language: Shell
- Homepage:
- Size: 53.7 KB
- Stars: 27
- Watchers: 6
- Forks: 12
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ttfautohint-build
[](https://github.com/source-foundry/ttfautohint-build/actions/workflows/linux-ci.yml)
[](https://github.com/source-foundry/ttfautohint-build/actions/workflows/macos-ci.yml)
## About
ttfautohint-build includes a simple, straightforward [ttfautohint](https://www.freetype.org/ttfautohint/) build from scratch approach on Linux and macOS platforms. [FreeType](https://www.freetype.org/) and [Harfbuzz](https://github.com/behdad/harfbuzz) build dependencies (at appropriate release versions) are included in the installation.
The build script is `ttfautohint-build.sh` (located in the root of the repository). This script is linted with `shellcheck` & `checkbashisms` and is tested for build execution completion on Ubuntu Linux and macOS v10.10-v10.15 using [the Travis CI service](https://travis-ci.org/source-foundry/ttfautohint-build).
Builds employ a simple `make` workflow that does not require super user permissions.
If you are looking for a simple way to install + use ttfautohint and do not need to build the application from source, check out the free, open [ttfautohint-py project](https://github.com/fonttools/ttfautohint-py).
## Pre-Install Build Dependencies
### Linux
- None
### macOS
- macOS v10.11 and above
- XCode v7.3 and above
## Usage
Select one of the following approaches to install the current release of `ttfautohint`.
### git clone Approach
```
$ git clone https://github.com/source-foundry/ttfautohint-build.git
$ cd ttfautohint-build
$ make
```
### cURL Approach
```
$ curl -L -O https://github.com/source-foundry/ttfautohint-build/archive/v1.8.3.2.tar.gz
$ tar -xzvf v1.8.3.2.tar.gz
$ cd ttfautohint-build-1.8.3.2
$ make
```
With both of the above approaches, the `ttfautohint` executable is installed on the path `$HOME/ttfautohint-build/local/bin/ttfautohint`.
### ttfautohint Execution
You can use the following approaches to execute `ttfautohint` with your font files:
#### Shell Scripts
```
# without shell script constant
"$HOME/ttfautohint-build/local/bin/ttfautohint" [ttfautohint args]
```
```
# with shell script constant
TTFAH="$HOME/ttfautohint-build/local/bin/ttfautohint"
"$TTFAH" [ttfautohint args]
```
#### Command Line
Modify the PATH definition in your shell settings file (e.g. .bashrc if you are using bash) with the following line **after** PATH is defined in the file:
```
export PATH="$HOME/ttfautohint-build/local/bin/:$PATH"
```
then, source your shell settings file on the command line with:
```
$ source [shell settings file path]
```
You can then use `ttfautohint` on the command line as follows:
```
$ ttfautohint [ttfautohint args]
```
## Changes
Please see the changelog in [the project releases](https://github.com/source-foundry/ttfautohint-build/releases).
## License
[MIT License](LICENSE)