https://github.com/jonpalmisc/vfit
Utility for building static cuts of variable fonts
https://github.com/jonpalmisc/vfit
fonts fonttools variable-fonts
Last synced: 5 months ago
JSON representation
Utility for building static cuts of variable fonts
- Host: GitHub
- URL: https://github.com/jonpalmisc/vfit
- Owner: jonpalmisc
- License: mit
- Created: 2020-07-18T16:56:02.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-25T02:57:24.000Z (about 3 years ago)
- Last Synced: 2024-10-30T16:44:52.006Z (6 months ago)
- Topics: fonts, fonttools, variable-fonts
- Language: Python
- Homepage:
- Size: 153 KB
- Stars: 52
- Watchers: 5
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
## About
VFIT (Variable Font Instancing Tool) allows you to generate custom, static
instances of a variable font defined in a configuration file.
## Installation
VFIT is now available on the Python Package Index. You can install VFIT with
the following command:
```sh
$ pip3 install vfit
```
Alternatively, you can install VFIT by downloading a pre-built wheel from the
Releases section or by building it yourself.
``` sh
# Skip this step if you're downloading a prebuilt wheel.
$ git clone https://github.com/jonpalmisc/vfit.git && cd vfit
$ poetry build && cd dist
# Install VFIT from the wheel.
$ pip install vfit-version-py3-none-any.whl
```
## Usage
To begin, you will need a variable font file to work with. Your first step will
be creating a configuration file. See `sample.json` for an example.
Next, run VFIT and pass your configuration and variable font file as arguments:
``` sh
$ vfit config.json variable.ttf
```
If you would like to generate instances into a specific directory, you can use
the `-o` option. For more options, see `vfit --help`.
## Contributing
All contributions are welcome. If you find a bug or have a request for a
feature, feel free to create a new issue (or even better, a pull request).
If you are submitting a pull request, please format your code with `yapf` using
the default settings. Additionally, I am aware that camelCase naming is against
the convention for Python, but it is the convention used by `fonttools`, so I
have chosen to use it here as well for consistency.
## Credits
Special thanks to [Viktor Rubenko](https://github.com/ViktorRubenko), who knows
way more about font technology than I do and has been incredibly helpful in
fixing strange bugs.
The VFIT logo uses [NewGlyph](https://beta.newglyph.com/)'s
[Armada](https://beta.newglyph.com/discovery-collection/#font-armada) variable
font.
## License
Copyright © 2020 Jon Palmisciano
VFIT is available under the MIT License. See [LICENSE.txt](LICENSE.txt) for
more information.