Skip to content

readme: mention how to install Rust tools and how to use them within gftools. #1120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
m4rc1e wants to merge 1 commit into
base: main
Choose a base branch
from
Open

readme: mention how to install Rust tools and how to use them within gftools. #1120

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,18 @@ If you would like to use `gftools qa`:
pip install 'gftools[qa]'


**Experimental Rust tooling**

Google Fonts is porting all of their font compilation and font qa tooling to Rust. To install the Rust tools to your virtualenv do the following:

`/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/googlefonts/gftools/main/bin/install_rust_binaries.sh)"`


To QA fonts using the Rust tools fontspector and diffenator. Append the `--rust` flag to `gftools qa`

To Build fonts using fontc. Append `--experimental-fontc` to `gftools builder`.


### Tool Requirements and Dependencies

`gftools packager` needs the command line `git` program in a version >= Git 2.5 (Q2 2015) in order to perform a shallow clone (`--depth 1`) of the font upstream repository and branch. This is not supported by pygit2/libgit2 yet.
Expand Down
Loading