Skip to content

Latest commit

 

History

History
90 lines (55 loc) · 6.51 KB

README.md

File metadata and controls

90 lines (55 loc) · 6.51 KB
Raw

Setting up your font

  • New repositories. Hit the green button above ("Use this template") to create your own repository. Please note that a Github Action job will be executed once you've created the repository which will populate the readme. This may take a few minutes. Please wait for this job to complete before pulling the repo to your local system.*

  • Updating a repository. To update your font repository to bring in the latest best-practices from our Unified Font Repository, run make update-ufr from the command line.

  • Replace the font sources in the sources directory with your own font sources. These sources may be either in Glyphs format or UFO/Designspace formats.

    Unlike many open source distributors, Google Fonts is curated. Fonts shipped to the platform have to match the Google Fonts Specifications. Please read them carefully.

    (The sample font provided in this template is Rubik by Philipp Hubert, Sebastian Fischer, and contributors.)

  • Then reference the sources in the file sources/config.yaml, as well as making any other changes you would like to make based on the instructions in the Google Fonts Builder documentation.

  • Add yourself to the AUTHORS.txt and CONTRIBUTORS.txt files.

  • Update the first line of the OFL.txt (year and project name). Update also the Copyright string in the sources, it has to be the same as the OFL.txt. The .glyphs file in this repo gives you required base charset and font info.

  • Finally, add and commit any files you have modified (i.e. README.md, AUTHORS.txt, CONTRIBUTORS.txt, the font sources, and sources/config.yaml) to git, then push to GitHub. Please be aware that Github Actions may take a few minutes to build your font family. It is worthwhile inspecting the progress in the "Actions" tab.

  • If Github Actions has successfully built the family, you will find the font binaries in the Actions tab. The official Github Actions documentation provides further information.

  • Once you are happy with your font, add promotional assets in the documentation directory. Make it different from the pic you use in this README. You can get inspired by existing tweet @googlefonts like: https://twitter.com/googlefonts/status/1415562928657416192.

  • Google Fonts uses Github Releases to manage font families. If you feel your font project has hit a milestone, you must create a new release for it. In order to do this, go to the releases page and hit the "Draft a new release button". You must provide a tag number and title which can only be a decimal number e.g 0.100, 1.000 etc. For the body text, mention what has changed since the last release. Once you are done, hit the "Publish release" button. Here is an example which fulfills the requirements, https://github.com/m4rc1e/test-ufr-family/releases/tag/2.019. For more info regarding Github release, please see the official Github Release documentation. Please note that Github Actions must be able to build the fonts before you can make a release. Once you have made a release, the fonts and tests assets will be attached to the release automatically. This may take a while since the fonts and tests will be built from scratch so please be patient.

  • Remove this section from the readme. :-)

My Font

Description of your font goes here. We recommend to start with a very short presentation line (the kind you would use on twitter to present your project for example), and then add as much details as necesary :-) Origin of the project, idea of usage, concept of creation… but also number of masters, axes, character sets, etc.

Don't hesitate to create images!

Sample Image

About

Description of you and/or organisation goes here.

Building

Fonts are built automatically by GitHub Actions - take a look in the "Actions" tab for the latest build.

If you want to build fonts manually on your own computer:

  • make build will produce font files.
  • make test will run FontBakery's quality assurance tests.
  • make proof will generate HTML proof files.

The proof files and QA tests are also available automatically via GitHub Actions - look at https://EbenSorkin.github.io/Merriweather4.

Changelog

When you update your font (new version or new release), please report all notable changes here, with a date. Font Versioning is based on semver. Changelog example:

26 May 2021. Version 2.13

  • MAJOR Font turned to a variable font.
  • SIGNIFICANT New Stylistic sets added.

License

This Font Software is licensed under the SIL Open Font License, Version 1.1. This license is available with a FAQ at https://scripts.sil.org/OFL

Repository Layout

This font repository structure is inspired by Unified Font Repository v0.3, modified for the Google Fonts workflow.