]> git.ipfire.org Git - thirdparty/google/fonts.git/blame - README.md
New GFK axis additions for early 2024 (#7354)
[thirdparty/google/fonts.git] / README.md
CommitLineData
af3b61fc 1[![CI Status](https://github.com/google/fonts/workflows/Continuous%20Test/badge.svg?branch=main)](https://github.com/google/fonts/actions/workflows/ci.yml?query=workflow%3ATest+branch%3Amain)
3690f7e4 2
78bd932d 3# Google Fonts Files
90abd17b 4
0561cddc 5This project mainly contains the binary font files served by Google Fonts ([fonts.google.com](https://fonts.google.com))
90abd17b 6
a88ef45b 7The top-level directories indicate the license of all files found within them.
01c5aa9a 8Subdirectories are named according to the family name of the fonts within.
90abd17b 9
01c5aa9a 10Each family subdirectory contains the `.ttf` font files served by Google Fonts, plus a `METADATA.pb` file with metadata for the family (such as information on the project designer(s), genre category, and license - [learn more](https://github.com/googlefonts/gf-docs/tree/master/METADATA)) and a `DESCRIPTION.en_us.html` with a description of the family in US English.
90abd17b 11
9e5e0860 12The `/catalog` subdirectory contains additional metadata, such as profile texts and portrait/avatar images of font designers, and this is open for contributions and corrections from anyone via GitHub.
0561cddc 13
54f900ed
DC
14The `/axisregistry` subtree contains metadata for the GF Axis Registry, containing information on variable font axes that can be found in the collection, including experimental axes.
15As a subtree, no changes should be made directly to this repo, instead please use the upstream, [github.com/googlefonts/axisregistry](http://github.com/googlefonts/axisregistry)
16
17The `/lang` subtree contains language support data, and should also not be changed here but instead upstream.
18[github.com/googlefonts/lang](https://github.com/googlefonts/lang)
4bd3c05a 19
ca57b8c5 20## Bug Reports and Improvement Requests
503de5bb 21
a88ef45b 22If you find a problem with a font file or have a request for the future development of a font project, please [create a new issue in this project's issue tracker](https://github.com/google/fonts/issues).
503de5bb 23
5d93bf97
DC
24## Contribute Fonts
25
26If you need more context on how to create issues in a GitHub issue tracker, or if you want to contribute a font directly, see [CONTRIBUTING](https://github.com/google/fonts/blob/main/CONTRIBUTING.md)
27
ca57b8c5
EH
28## Contributor Code of Conduct
29
30However you choose to contribute, please abide by our [code of conduct](CODE_OF_CONDUCT.md) to keep our community a healthy and welcoming place.
31
89c68b76
DC
32## Self Host Fonts Available From Google Fonts
33
01c5aa9a
L
34Since all the fonts available here are licensed with permission to redistribute, subject to the license terms, you can self-host using a variety of third-party projects.
35
36One popular service is [Fontsource](https://github.com/fontsource/fontsource), which offers bundled NPM packages.
37
7790077c 38## Local installation package managers
01c5aa9a 39
7790077c 40For Linux, macOS, FreeBSD, or HaikuOS you can also use [fnt](https://github.com/alexmyczko/fnt), to install single fonts. For [RPM](http://bootes.ethz.ch/fonts/rpm/), [DEB](http://bootes.ethz.ch/fonts/deb/) based systems, feel free to try the linked URLs for individual fonts. Others can also use the [webservice](http://bootes.ethz.ch/fonts/).
89c68b76 41
4f5374de 42## Download All Google Fonts
90abd17b 43
8cc181c5 44You can download all Google Fonts in a simple ZIP snapshot (over 1GB) from <https://github.com/google/fonts/archive/main.zip>
4f5374de
DC
45
46#### Sync With Git
47
9e5e0860 48You can also sync the collection with git so that you can update by only fetching what has changed. To learn how to use git, GitHub provides [illustrated guides](https://guides.github.com), a [youtube channel](https://www.youtube.com/user/GitHubGuides), and an [interactive learning site](https://skills.github.com/).
a88ef45b 49Free, open-source git applications are available for [Windows](https://git-scm.com/download/gui/windows) and [Mac OS X](https://git-scm.com/download/gui/mac).
90620adf 50
01c5aa9a 51## License
4f5374de
DC
52
53It is important to always read the license for every font that you use.
01c5aa9a 54Each font family directory contains the appropriate license file for the fonts in that directory.
4f5374de 55The fonts files themselves also contain licensing and authorship metadata.
35a99385 56
90abd17b 57Most of the fonts in the collection use the SIL Open Font License, v1.1.
01c5aa9a
L
58Some fonts use the Apache 2 license.
59The Ubuntu fonts use the Ubuntu Font License v1.0.
90abd17b 60
01c5aa9a 61The SIL Open Font License has an option for copyright holders to include a Reserved Font Name requirement, and this option is used with some of the fonts.
4f5374de 62If you modify those fonts, please take care of this important detail.
90abd17b 63
90abd17b
DC
64## Source Files
65
0561cddc 66Source files for each family are often available from the designer, or from [github.com/googlefonts](https://github.com/googlefonts)
90abd17b 67
afa57799 68These fonts are usually the result of collaborative projects, where you are invited to discuss issues with the designers and even contribute to their ongoing development.
90abd17b 69
afa57799 70When customizing or remixing fonts, please do contact the designers to understand what they might need in order to include your improvements.
90abd17b
DC
71
72Most of all: Enjoy the fonts!
73
0a09bc89 74– The Google Fonts team