Git Product home page Git Product logo

fontbakery's Introduction

Latest PyPI Version Python Build Status License: Apache 2.0

Font Bakery

Font Bakery is a command-line tool for checking the quality of font projects.

For a quick overview, check out the list of checks currently offered.

And for a full introduction check out our documentation at Read The Docs.

A recording of the ATypI 2020 FontBakery presentation is also available.

Font Bakery has an active community of contributors from foundries around the world, including Adobe Fonts, Dalton Maag, Type Network, and Google Fonts. Please join our developer chat channel at https://gitter.im/fontbakery/Lobby

Font Bakery is not an official Google project, and Google provides no support for it. However, throughout 2018-2021 the core project maintainers Felipe Corrêa da Silva Sanches [email protected] and Lasse Fister [email protected] are commissioned by the Google Fonts team to maintain it.

Run Font Bakery automatically on Github Actions

Simon Cozens prepared a template git repo that makes it easy to build, check and proof fonts. He's also prepared a nice 1 minute video showcasing it.

License

Font Bakery is available under the Apache 2.0 license.

All comments on the issue tracker or on pull requests will be treated as also licensed under this license such that they can be incorporated into the project code.

Install

See the Font Bakery Installation Guide for your platform:

Usage

Font Bakery is primarily a Terminal app, learn more in the Command Line Usage Guide.

If you write little Python scripts in your workflow, you can easily write custom checks.

For full developer documentation, check out font-bakery.readthedocs.io (a hosted and compiled copy of contents in the /docs directory.)

Contributing

See the guide to Getting Started as a Contributor.

Web Dashboard

A web dashboard for monitoring check-results of project collections is at https://github.com/googlefonts/fontbakery-dashboard

History

The project was initiated by Dave Crossland in 2013 to accelerate the onboarding process for Google Fonts. In 2017 Lasse Fister and Felipe Sanches rewrote it into a modern, modular architecture suitable for both individuals and large distributors. Felipe has maintained the check contents since 2016.

Lasse also began a sister project, Font Bakery Dashboard: A UI and a cloud system that scales up for checking 1,000s of font files super fast and in parallel, by using 1,000s of "container" virtual machines. See his TypoLabs 2018 talk on YouTube and its presentation deck.

Most of the checks are for OpenType binary files, and project metadata files. (Currently, the Google Fonts METADATA.pb files are supported.)

If you are developing a font project publicly with Github (or a similar host) you can set up a Continuous Integration service (like Travis) to run Font Bakery on each commit, so that with each update all checks will be run on your files.

Trivia

fontbakery's People

Contributors

felipesanches avatar davelab6 avatar vitalyvolkov avatar xen avatar m4rc1e avatar graphicore avatar madig avatar simoncozens avatar miguelsousa avatar chrissimpkins avatar cjchapman avatar andriyko avatar yanone avatar moyogo avatar hugovk avatar jenskutilek avatar drj11 avatar aurium avatar josh-hadley avatar eniallator avatar thundernixon avatar eliheuer avatar adrientetar avatar anthrotype avatar kontur avatar ollimeier avatar rosawagner avatar bobh0303 avatar vv-monsalve avatar nyshadhr9 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.