googlefonts.github.io

README file

🦦 The README.md is a page you find at the root of any repository. It is the first readable text that a user can see when arriving in the repository on GitHub’s website.
This page will help designers to write a good README file.
Background reading:
must→ Upstream repository structure

Table of contents

What to include

The informations you provide in your font project’s README.md is key for GF and for users. It is therefore mandatory to apply the following instructions. Whilst only you can judge what makes sense or not for your font project description in term of detail and length, we can only recommend you to be generous with them:

Concrete examples

You may get inspire by these examples to build up your README.md. Please note that none is actually perfect, and ideally, you should combine the best part of them all if relevant to your project.


Further reading:
team  Description file