Skip to content

Commit 2bc8ffd

Browse files
simoncozenssimoncozens
committed
Initial commit
0 parents  commit 2bc8ffd

37 files changed

+2494
-0
lines changed

‎.github/workflows/build.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name: Build, QA, Release
2+
3+
on: push
4+
5+
jobs:
6+
build_font:
7+
uses: notofonts/notobuilder/.github/workflows/build.yaml@main
8+
secrets: inherit
9+

‎.gitignore

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
*~
2+
venv
3+
build.stamp
4+
proof
5+
fonts
6+
node_modules
7+
package-lock.json
8+
package.json
9+
10+
# OS generated files #
11+
######################
12+
.DS_Store
13+
.DS_Store?
14+
._*
15+
.Spotlight-V100
16+
.Trashes
17+
ehthumbs.db
18+
Thumbs.db

‎.init.stamp

Whitespace-only changes.

‎.templaterc.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"files": [".github/**/*", "Makefile", "scripts/**/*", "requirements.txt"]
3+
}

‎AUTHORS.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# This is the official list of project authors for copyright purposes.
2+
# This file is distinct from the CONTRIBUTORS.txt file.
3+
# See the latter for an explanation.
4+
#
5+
# Names should be added to this file as:
6+
# Name or Organization <email address>
7+

‎CONTRIBUTORS.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# This is the list of people who have contributed to this project,
2+
# and includes those not listed in AUTHORS.txt because they are not
3+
# copyright authors. For example, company employees may be listed
4+
# here because their company holds the copyright and is listed there.
5+
#
6+
# When adding J Random Contributor's name to this file, either J's
7+
# name or J's organization's name should be added to AUTHORS.txt
8+
#
9+
# Names should be added to this file as:
10+
# Name <email address>

‎Makefile

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
SOURCES=$(shell python3 scripts/read-config.py --sources )
2+
FAMILY=$(shell python3 scripts/read-config.py --family )
3+
4+
help:
5+
@echo "###"
6+
@echo "# Build targets for $(FAMILY)"
7+
@echo "###"
8+
@echo
9+
@echo " make build: Builds the fonts and places them in the fonts/ directory"
10+
@echo " make test: Tests the fonts with fontbakery"
11+
@echo " make proof: Creates HTML proof documents in the proof/ directory"
12+
@echo " make images: Creates PNG specimen images in the documentation/ directory"
13+
@echo
14+
15+
build: build.stamp
16+
17+
venv: venv/touchfile
18+
19+
build.stamp: venv .init.stamp sources/config*.yaml $(SOURCES)
20+
rm -rf fonts
21+
(for config in sources/config*.yaml; do . venv/bin/activate; python3 -m notobuilder $$config; done) && touch build.stamp
22+
23+
.init.stamp: venv
24+
. venv/bin/activate; python3 scripts/first-run.py
25+
26+
venv/touchfile: requirements.txt
27+
test -d venv || python3 -m venv venv
28+
. venv/bin/activate; pip install -Ur requirements.txt
29+
touch venv/touchfile
30+
31+
test: venv build.stamp
32+
. venv/bin/activate; python3 -m notoqa
33+
34+
proof: venv build.stamp
35+
. venv/bin/activate; mkdir -p out/ out/proof; gftools gen-html proof $(shell find fonts/*/unhinted/ttf -type f) -o out/proof
36+
37+
%.png: %.py build.stamp
38+
python3 $< --output $@
39+
40+
clean:
41+
rm -rf venv
42+
find . -name "*.pyc" | xargs rm delete
43+
44+
update-ufr:
45+
npx update-template https://github.com/notofonts/noto-project-template/
46+
47+
update:
48+
pip install --upgrade $(dependency)
49+
50+
manual_release: build.stamp
51+
@echo "Creating release files manually is contraindicated."
52+
@echo "Please use the CI for releases instead."
53+
cd fonts; for family in *; do VERSION=`font-v report $$family/unhinted/ttf/* | grep Version | sort -u | awk '{print $$2}'`; zip -r ../$$family-v$$VERSION.zip $$family; done
54+

‎OFL.txt

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
Copyright 20** The Noto Project Authors (https://github.com/notofonts/noto-project-template)
2+
3+
This Font Software is licensed under the SIL Open Font License, Version 1.1.
4+
This license is copied below, and is also available with a FAQ at:
5+
https://scripts.sil.org/OFL
6+
7+
8+
-----------------------------------------------------------
9+
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
10+
-----------------------------------------------------------
11+
12+
PREAMBLE
13+
The goals of the Open Font License (OFL) are to stimulate worldwide
14+
development of collaborative font projects, to support the font creation
15+
efforts of academic and linguistic communities, and to provide a free and
16+
open framework in which fonts may be shared and improved in partnership
17+
with others.
18+
19+
The OFL allows the licensed fonts to be used, studied, modified and
20+
redistributed freely as long as they are not sold by themselves. The
21+
fonts, including any derivative works, can be bundled, embedded,
22+
redistributed and/or sold with any software provided that any reserved
23+
names are not used by derivative works. The fonts and derivatives,
24+
however, cannot be released under any other type of license. The
25+
requirement for fonts to remain under this license does not apply
26+
to any document created using the fonts or their derivatives.
27+
28+
DEFINITIONS
29+
"Font Software" refers to the set of files released by the Copyright
30+
Holder(s) under this license and clearly marked as such. This may
31+
include source files, build scripts and documentation.
32+
33+
"Reserved Font Name" refers to any names specified as such after the
34+
copyright statement(s).
35+
36+
"Original Version" refers to the collection of Font Software components as
37+
distributed by the Copyright Holder(s).
38+
39+
"Modified Version" refers to any derivative made by adding to, deleting,
40+
or substituting -- in part or in whole -- any of the components of the
41+
Original Version, by changing formats or by porting the Font Software to a
42+
new environment.
43+
44+
"Author" refers to any designer, engineer, programmer, technical
45+
writer or other person who contributed to the Font Software.
46+
47+
PERMISSION & CONDITIONS
48+
Permission is hereby granted, free of charge, to any person obtaining
49+
a copy of the Font Software, to use, study, copy, merge, embed, modify,
50+
redistribute, and sell modified and unmodified copies of the Font
51+
Software, subject to the following conditions:
52+
53+
1) Neither the Font Software nor any of its individual components,
54+
in Original or Modified Versions, may be sold by itself.
55+
56+
2) Original or Modified Versions of the Font Software may be bundled,
57+
redistributed and/or sold with any software, provided that each copy
58+
contains the above copyright notice and this license. These can be
59+
included either as stand-alone text files, human-readable headers or
60+
in the appropriate machine-readable metadata fields within text or
61+
binary files as long as those fields can be easily viewed by the user.
62+
63+
3) No Modified Version of the Font Software may use the Reserved Font
64+
Name(s) unless explicit written permission is granted by the corresponding
65+
Copyright Holder. This restriction only applies to the primary font name as
66+
presented to the users.
67+
68+
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
69+
Software shall not be used to promote, endorse or advertise any
70+
Modified Version, except to acknowledge the contribution(s) of the
71+
Copyright Holder(s) and the Author(s) or with their explicit written
72+
permission.
73+
74+
5) The Font Software, modified or unmodified, in part or in whole,
75+
must be distributed entirely under this license, and must not be
76+
distributed under any other license. The requirement for fonts to
77+
remain under this license does not apply to any document created
78+
using the Font Software.
79+
80+
TERMINATION
81+
This license becomes null and void if any of the above conditions are
82+
not met.
83+
84+
DISCLAIMER
85+
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
86+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
87+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
88+
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
89+
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
90+
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
91+
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
92+
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
93+
OTHER DEALINGS IN THE FONT SOFTWARE.

‎README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Noto My Font
2+
3+
[![][Fontbakery]](https://notofonts.github.io/noto-project-template/fontbakery/fontbakery-report.html)
4+
[![][Universal]](https://notofonts.github.io/noto-project-template/fontbakery/fontbakery-report.html)
5+
[![][GF Profile]](https://notofonts.github.io/noto-project-template/fontbakery/fontbakery-report.html)
6+
[![][Outline Correctness]](https://notofonts.github.io/noto-project-template/fontbakery/fontbakery-report.html)
7+
[![][Shaping]](https://notofonts.github.io/noto-project-template/fontbakery/fontbakery-report.html)
8+
9+
[Fontbakery]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fnotofonts%2Fnoto-project-template%2Fgh-pages%2Fbadges%2Foverall.json
10+
[GF Profile]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fnotofonts%2Fnoto-project-template%2Fgh-pages%2Fbadges%2FGoogleFonts.json
11+
[Noto Profile]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fnotofonts%2Fnoto-project-template%2Fgh-pages%2Fbadges%2FNotoFonts.json
12+
[Outline Correctness]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fnotofonts%2Fnoto-project-template%2Fgh-pages%2Fbadges%2FOutlineCorrectnessChecks.json
13+
[Shaping]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fnotofonts%2Fnoto-project-template%2Fgh-pages%2Fbadges%2FShapingChecks.json
14+
[Universal]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fnotofonts%2Fnoto-project-template%2Fgh-pages%2Fbadges%2FUniversal.json
15+
16+
## Building
17+
18+
Fonts are built automatically by GitHub Actions - take a look in the "Actions" tab for the latest build.
19+
20+
If you want to build fonts manually on your own computer:
21+
22+
* `make build` will produce font files.
23+
* `make test` will run [FontBakery](https://github.com/googlefonts/fontbakery)'s quality assurance tests.
24+
* `make proof` will generate HTML proof files.
25+
26+
The proof files and QA tests are also available automatically via GitHub Actions - look at `https://yourname.github.io/your-font-repository-name`.
27+
28+
For information on how to work on Noto fonts, how the build process
29+
works and how to maintain it, see [the README file of the
30+
notofonts.github.io
31+
repository](https://github.com/notofonts/notofonts.github.io/blob/main/README.md)
32+
33+
## License
34+
35+
This Font Software is licensed under the SIL Open Font License, Version 1.1.
36+
This license is available with a FAQ at
37+
https://scripts.sil.org/OFL

‎fontbakery.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
com.google.fonts/check/shaping:
2+
test_directory: qa/shaping_tests

0 commit comments

Comments
 (0)