Skip to content

Commit

Permalink
Customize repository
Browse files Browse the repository at this point in the history
  • Loading branch information
pathumego committed Dec 27, 2024
1 parent ea1f175 commit 065e5cc
Show file tree
Hide file tree
Showing 3 changed files with 148 additions and 62 deletions.
4 changes: 2 additions & 2 deletions OFL.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 20** The My Font Project Authors (https://github.com/googlefonts/googlefonts-project-template)
Copyright 2024 The Colvin-Font.Git Project Authors (https://github.com/mooniak/colvin-font.git)

This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
Expand Down Expand Up @@ -90,4 +90,4 @@ COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.
OTHER DEALINGS IN THE FONT SOFTWARE.
69 changes: 11 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,16 @@
----
# Colvin

## Setting up your font
[![][Fontbakery]](https://mooniak.github.io/colvin-font.git/fontbakery/fontbakery-report.html)
[![][Universal]](https://mooniak.github.io/colvin-font.git/fontbakery/fontbakery-report.html)
[![][GF Profile]](https://mooniak.github.io/colvin-font.git/fontbakery/fontbakery-report.html)
[![][Shaping]](https://mooniak.github.io/colvin-font.git/fontbakery/fontbakery-report.html)

### 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).


### Updating a repository

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.

2. To update the Python build chain which builds your fonts, run `make update` and `git add`/`git commit` the new `requirements.txt`.

## More things to do

* `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).

* 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](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.**

----


# My Font

[![][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)

[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
[Fontbakery]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fmooniak%2Fcolvin-font.git%2Fgh-pages%2Fbadges%2Foverall.json
[GF Profile]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fmooniak%2Fcolvin-font.git%2Fgh-pages%2Fbadges%2FGoogleFonts.json
[Outline Correctness]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fmooniak%2Fcolvin-font.git%2Fgh-pages%2Fbadges%2FOutlineCorrectnessChecks.json
[Shaping]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fmooniak%2Fcolvin-font.git%2Fgh-pages%2Fbadges%2FShapingChecks.json
[Universal]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fmooniak%2Fcolvin-font.git%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.

Expand All @@ -80,7 +33,7 @@ If you want to build fonts manually on your own computer:
* `make test` will run [FontBakery](https://github.com/googlefonts/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://yourname.github.io/your-font-repository-name`.
The proof files and QA tests are also available automatically via GitHub Actions - look at https://mooniak.github.io/colvin-font.git.

## Changelog

Expand Down
137 changes: 135 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,135 @@
# Placeholder file, update the requirements by running `make update`.
-r requirements.in
absl-py==2.1.0
afdko==4.0.2
appdirs==1.4.4
attrs==24.3.0
axisregistry==0.4.11
babelfont==3.1.2
beautifulsoup4==4.12.3
beziers==0.6.0
blackrenderer==0.6.0
booleanOperations==0.9.0
Brotli==1.1.0
bump2version==1.0.1
bumpfontversion==0.4.1
cattrs==24.1.2
certifi==2024.12.14
cffi==1.17.1
cffsubr==0.3.0
charset-normalizer==3.4.1
cmarkgfm==2024.11.20
collidoscope==0.6.5
commandlines==0.4.1
compreffor==0.5.6
cryptography==44.0.0
defcon==0.10.3
dehinter==4.0.0
Deprecated==1.2.15
diffenator2==0.4.5
docopt==0.6.2
drawbot-skia==0.5.1
filelock==3.16.1
font-v==2.1.0
fontbakery==0.11.2
fontFeatures==1.8.0
fontmake==3.10.0
fontMath==0.9.4
fontParts==0.12.3
fontPens==0.2.4
fonttools==4.55.3
freetype-py==2.5.1
fs==2.4.16
gflanguages==0.7.1
gfsubsets==2024.9.25
gftools==0.9.76
gitdb==4.0.11
GitPython==3.1.43
glyphsets==1.1.0
glyphsLib==6.9.5
h11==0.14.0
idna==3.10
importlib_resources==6.4.5
Jinja2==3.1.5
kurbopy==0.11.1
lxml==5.3.0
markdown-it-py==3.0.0
MarkupSafe==3.0.2
mdurl==0.1.2
munkres==1.1.4
MutatorMath==3.0.1
nanoemoji==0.15.1
networkx==3.4.2
ninja==1.11.1.3
num2words==0.5.14
numpy==2.2.1
openstep_plist==0.4.0
opentype-sanitizer==9.2.0
opentypespec==1.9.1
orjson==3.10.12
outcome==1.3.0.post0
packaging==24.2
picosvg==0.22.1
pillow==11.0.0
pip-api==0.0.34
pngquant-cli==3.0.3
protobuf==3.20.3
pyahocorasick==2.1.0
pybind11==2.13.6
pycairo==1.27.0
pyclipper==1.3.0.post6
pycparser==2.22
pygit2==1.16.0
PyGithub==2.5.0
Pygments==2.18.0
PyJWT==2.10.1
PyNaCl==1.5.0
pyparsing==3.2.0
PySocks==1.7.1
python-bidi==0.4.2
python-dateutil==2.9.0.post0
PyYAML==6.0.2
regex==2024.11.6
requests==2.32.3
resvg-cli==0.44.0
rich==13.9.4
rstr==3.2.2
ruamel.yaml==0.18.6
selenium==4.27.1
setuptools==75.6.0
sh==2.1.0
shaperglot==0.6.4
six==1.17.0
skia-pathops==0.8.0.post2
skia-python==132.0b11
smmap==5.0.1
sniffio==1.3.1
sortedcontainers==2.4.0
soupsieve==2.6
sre-yield==1.2
statmake==0.6.0
strictyaml==1.7.3
stringbrewer==0.0.1
tabulate==0.9.0
termcolor==2.5.0
toml==0.10.2
tqdm==4.67.1
trio==0.28.0
trio-websocket==0.11.1
ttfautohint-py==0.5.1
typing_extensions==4.12.2
ufo2ft==3.3.1
ufoLib2==0.17.0
ufolint==1.2.0
ufomerge==1.8.2
ufonormalizer==0.6.2
ufoProcessor==1.13.3
uharfbuzz==0.44.0
unicodedata2==15.1.0
Unidecode==1.3.8
urllib3==2.3.0
vharfbuzz==0.3.1
vttLib==0.12.0
websocket-client==1.8.0
wrapt==1.17.0
wsproto==1.2.0
youseedee==0.5.3
zopfli==0.2.3.post1

0 comments on commit 065e5cc

Please sign in to comment.