]> git.ipfire.org Git - thirdparty/google/fonts.git/blob - README.md
Merge pull request #7613 from google/knowledge-fix-tags
[thirdparty/google/fonts.git] / README.md
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)
2
3 # Google Fonts Files
4
5 This project mainly contains the binary font files served by Google Fonts ([fonts.google.com](https://fonts.google.com))
6
7 The top-level directories indicate the license of all files found within them.
8 Subdirectories are named according to the family name of the fonts within.
9
10 Each 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.
11
12 The `/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.
13
14 The `/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.
15 As 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
17 The `/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)
19
20 ## Bug Reports and Improvement Requests
21
22 If 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).
23
24 ## Contribute Fonts
25
26 If 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
28 ## Contributor Code of Conduct
29
30 However 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
32 ## Self Host Fonts Available From Google Fonts
33
34 Since 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
36 One popular service is [Fontsource](https://github.com/fontsource/fontsource), which offers bundled NPM packages.
37
38 ## Local installation package managers
39
40 For 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/).
41
42 ## Download All Google Fonts
43
44 You can download all Google Fonts in a simple ZIP snapshot (over 1GB) from <https://github.com/google/fonts/archive/main.zip>
45
46 #### Sync With Git
47
48 You 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/).
49 Free, 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).
50
51 ## License
52
53 It is important to always read the license for every font that you use.
54 Each font family directory contains the appropriate license file for the fonts in that directory.
55 The fonts files themselves also contain licensing and authorship metadata.
56
57 Most of the fonts in the collection use the SIL Open Font License, v1.1.
58 Some fonts use the Apache 2 license.
59 The Ubuntu fonts use the Ubuntu Font License v1.0.
60
61 The 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.
62 If you modify those fonts, please take care of this important detail.
63
64 ## Source Files
65
66 Source files for each family are often available from the designer, or from [github.com/googlefonts](https://github.com/googlefonts)
67
68 These 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.
69
70 When customizing or remixing fonts, please do contact the designers to understand what they might need in order to include your improvements.
71
72 Most of all: Enjoy the fonts!
73
74 – The Google Fonts team