generated from googlefonts/googlefonts-project-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9242345
commit 8c5f3fb
Showing
535 changed files
with
87,912 additions
and
147,289 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,103 +1,92 @@ | ||
---- | ||
# Triodion Typeface | ||
|
||
## Setting up your font | ||
|
||
### New repositories | ||
|
||
1. Hit the green button above ("Use this template") to create your own repository. | ||
|
||
2. Clone the repository, and 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](https://github.com/googlefonts/gf-docs/tree/main/Spec). Please read them carefully.\ | ||
\ | ||
*(The sample font provided in this template is [Radio Canada](https://github.com/googlefonts/radiocanadadisplay/) by Charles Daoud, Etienne Aubert Bonn, Alexandre Saumier Demers and contributors.)* | ||
|
||
3. 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](https://github.com/googlefonts/gftools/blob/main/Lib/gftools/builder/__init__.py). | ||
|
||
4. Add yourself to the `AUTHORS.txt` and `CONTRIBUTORS.txt` files. | ||
|
||
5. Fill out `documentation/DESCRIPTION.en_us.html` with a description about your font. | ||
|
||
6. Rewrite this Readme file according to the recommendations in the [Google Fonts Guide](https://googlefonts.github.io/gf-guide/readmefile.html). | ||
|
||
7. Add and commit these files to git. | ||
|
||
8. **At the command line, run `make customize` to ensure that all the paths and URLs in your project are correct**. This will also push your changes to GitHub. | ||
|
||
9. **Set up your GitHub pages site**: go to Settings > Pages and ensure that the "Source" drop-down is set to "Deploy from a Branch". Ensure that the "Branch" is set to `gh-pages`. If this branch is not available, check that the "Build font and specimen" action in the "Actions" tab has completed; if it completed successfully, then try again - `gh-pages` should now be an option. | ||
|
||
10. 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](https://docs.github.com/en/actions/managing-workflow-runs/downloading-workflow-artifacts). | ||
Triodion is a contemporary Church Slavonic font that reproduces the typeface most commonly used in liturgical books published in | ||
St. Petersburg and Moscow at the end of the 19th and beginning of | ||
the 20th century and the current editions printed in Moscow | ||
by the Publishing House of the Moscow Patriarchate. | ||
|
||
![Sample Image](documentation/image2.png) | ||
|
||
### Updating a repository | ||
Pochaevsk is a contemporary Church Slavonic font that reproduces the typeface used in editions published by the Holy Dormition Pochaiv Lavra in the late 19th century and, subsequently, in editions published in the 20th century by Holy Trinity Monastery in Jordanville, New York. | ||
|
||
1. To update your font repository to bring in the latest best-practices from the Google Fonts Project Template, run `make update-project-template` from the command line. This requires the `node` Javascript engine to be installed; if you don't have that already, [follow these instructions](https://nodejs.org/en/download/package-manager#macos) to install on your platform. | ||
Due to its small vertical metrics, this font is convenient | ||
for use in bilingual editions featuring Church Slavonic text | ||
and text in another language. | ||
|
||
2. To update the Python build chain which builds your fonts, run `make update` and `git add`/`git commit` the new `requirements.txt`. | ||
![Sample Image](documentation/image2.png) | ||
|
||
## More things to do | ||
## History | ||
|
||
* `CustomFilter_GF_Latin_All.plist` in `sources` is practical if you use GlyphsApp, you can remove it otherwise. Placed in the same directory as the your `.glyphs` file, it will allow Glyphs to display a filter list for all GF Latin glyphsets in app. To make sure your font supports the minimal set required by Google Fonts, look at the `GF_Latin_Core` filter list. Find other glyphsets and list formats for different software in [GF Glyphsets repository](https://github.com/googlefonts/glyphsets/tree/main/GF_glyphsets). | ||
As far as is known, Triodion was created for the | ||
[Irmologion project](http://irmologion.ru/fonts.html#triodion) by | ||
Vlad Dorosh as Triodion Ucs (version 1, 2003) and was then | ||
released under the LaTeX Project Public License as part of | ||
[CSLTeX](https://sites.google.com/site/csltex/). Reencoded for Unicode | ||
by Aleksandr Andreev as part of the | ||
[Slavonic Computing Initiative](https://sci.ponomar.net/fonts.html) | ||
and edited, released under SIL OFL v. 1.1. | ||
Edited by Aleksandr Andreev for Google Fonts. | ||
|
||
* 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. | ||
## License | ||
|
||
* 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](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository). **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.** | ||
This Font Software is licensed under the SIL Open Font License, | ||
Version 1.1. This license is available with a FAQ at | ||
[https://openfontlicense.org/](https://openfontlicense.org/). | ||
|
||
---- | ||
## Building the Fonts | ||
|
||
The font is built using fontmake and gftools post processing script. Tools are all python based, so it must be previously installed. | ||
|
||
# My Font | ||
To install all the Python tools into a virtualenv, do the following: | ||
|
||
[![][Fontbakery]](https://googlefonts.github.io/googlefonts-project-template/fontbakery/fontbakery-report.html) | ||
[![][Universal]](https://googlefonts.github.io/googlefonts-project-template/fontbakery/fontbakery-report.html) | ||
[![][GF Profile]](https://googlefonts.github.io/googlefonts-project-template/fontbakery/fontbakery-report.html) | ||
[![][Shaping]](https://googlefonts.github.io/googlefonts-project-template/fontbakery/fontbakery-report.html) | ||
From terminal: | ||
|
||
[Fontbakery]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgooglefonts%2Fgooglefonts-project-template%2Fgh-pages%2Fbadges%2Foverall.json | ||
[GF Profile]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgooglefonts%2Fgooglefonts-project-template%2Fgh-pages%2Fbadges%2FGoogleFonts.json | ||
[Outline Correctness]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgooglefonts%2Fgooglefonts-project-template%2Fgh-pages%2Fbadges%2FOutlineCorrectnessChecks.json | ||
[Shaping]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgooglefonts%2Fgooglefonts-project-template%2Fgh-pages%2Fbadges%2FShapingChecks.json | ||
[Universal]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgooglefonts%2Fgooglefonts-project-template%2Fgh-pages%2Fbadges%2FUniversal.json | ||
``` | ||
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. | ||
cd your/local/project/directory | ||
Don't hesitate to create images! | ||
#once in the project folder create a virtual environment. | ||
This step has to be done just once, the first time: | ||
![Sample Image](documentation/image1.png) | ||
![Sample Image](documentation/image2.png) | ||
python3 -m venv venv | ||
## About | ||
#activate the virtual environment | ||
Description of you and/or organisation goes here. | ||
source venv/bin/activate | ||
## Building | ||
#install the required dependencies | ||
Fonts are built automatically by GitHub Actions - take a look in the "Actions" tab for the latest build. | ||
pip install -r requirements.txt | ||
If you want to build fonts manually on your own computer: | ||
``` | ||
|
||
* `make build` will produce font files. | ||
* `make test` will run [FontBakery](https://github.com/googlefonts/fontbakery)'s quality assurance tests. | ||
* `make proof` will generate HTML proof files. | ||
Then run the this command: | ||
|
||
The proof files and QA tests are also available automatically via GitHub Actions - look at `https://yourname.github.io/your-font-repository-name`. | ||
``` | ||
cd sources | ||
gftools builder config.yaml | ||
``` | ||
|
||
## Changelog | ||
The fonts are supposed to build automatically in the repository | ||
using GitHub Actions, but this does not work correctly, | ||
presumably because of bugs on Google's part. | ||
|
||
When you update your font (new version or new release), please report all notable changes here, with a date. | ||
[Font Versioning](https://github.com/googlefonts/gf-docs/tree/main/Spec#font-versioning) is based on semver. | ||
Changelog example: | ||
## Features | ||
|
||
**26 May 2021. Version 2.13** | ||
- MAJOR Font turned to a variable font. | ||
- SIGNIFICANT New Stylistic sets added. | ||
* Stylistic Set 1 (*ss01*) changes the hyphen symbol (-) to an | ||
underscore (_), which is the default hyphenation symbol used | ||
in Synodal Church Slavonic. This can be used for software such | ||
as LibreOffice that does not support changing the default | ||
hyphenation character. | ||
|
||
## License | ||
* Stylistic Alternatives (*salt*) are provided for the following | ||
characters: | ||
- a short version of lowercase yat (U+0463) | ||
- an alternative form of capital omega (U+0460) | ||
- seven alternative forms of the Symbol for Mark's Chapter (U+1F545) | ||
|
||
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 | ||
See your software's documentation about how to access these glyphs. | ||
|
||
## Repository Layout | ||
## More Church Slavonic Fonts | ||
|
||
This font repository structure is inspired by [Unified Font Repository v0.3](https://github.com/unified-font-repository/Unified-Font-Repository), modified for the Google Fonts workflow. | ||
See the [main repository](https://github.com/typiconman/fonts-cu/issues) and the [website](https://sci.ponomar.net/fonts.html). |
This file was deleted.
Oops, something went wrong.
Binary file not shown.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.