Merge pull request #47 from aaronbell/master

Updating the repository to UFR

Author: alexeiva

.github/workflows/build.yaml

@@ -0,0 +1,37 @@
+name: Build font and specimen
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    - name: Install Linux dependencies
+      run: |
+        sudo snap install yq
+    - name: Build font
+      run: make build
+    - name: Check with fontbakery
+      run: make test
+      continue-on-error: true
+    - name: Generate proofs
+      run: make proof
+    - name: Gather
+      run: |
+          mkdir for-gh-pages
+          mv fontbakery-report.html for-gh-pages
+          mv proof/* for-gh-pages
+    - name: Archive artifacts
+      uses: actions/upload-artifact@v2
+      with:
+        name: Artifacts
+        path: |
+          for-gh-pages
+    - name: Remove temp folder
+      run: |
+          rm -rf for-gh-pages

.gitignore

@@ -1 +1,14 @@
+*~
+venv
+build.stamp
+proof
+
+# OS generated files #
+######################
 .DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db

Makefile

@@ -0,0 +1,34 @@
+SOURCES=$(shell yq e '.sources.[] | sub("^","sources/")' sources/config.yaml )
+FAMILY=$(shell yq e '.familyName' sources/config.yaml )
+
+help:
+	@echo "###"
+	@echo "# Build targets for $(FAMILY)"
+	@echo "###"
+	@echo
+	@echo "  make build: Builds the fonts and places them in the fonts/ directory"
+	@echo "  make test:  Tests the fonts with fontbakery"
+	@echo "  make proof: Creates HTML proof documents in the proof/ directory"
+	@echo
+
+build: build.stamp sources/config.yaml $(SOURCES)
+
+venv: venv/touchfile
+
+build.stamp: venv
+	. venv/bin/activate; gftools builder sources/config.yaml && touch build.stamp
+
+venv/touchfile: requirements.txt
+	test -d venv || python3 -m venv venv
+	. venv/bin/activate; pip install -Ur requirements.txt
+	touch venv/touchfile
+
+test: venv build.stamp
+	. venv/bin/activate; fontbakery check-googlefonts --html fontbakery-report.html --ghmarkdown fontbakery-report.md $(shell find fonts -type f)
+
+proof: venv build.stamp
+	. venv/bin/activate; gftools gen-html proof $(shell find fonts/ttf -type f) -o proof
+
+clean:
+	rm -rf venv
+	find -iname "*.pyc" -delete

README.md

@@ -35,8 +35,24 @@ Expansion to GF Cyrillic Plus, Pro, and locl has been completed by original auth
 
 Vietnamese glyphs were added by Nhung Nguyen @crystaltype
 
-### License
+## Building
+
+Fonts are built automatically by GitHub Actions - take a look in the "Actions" tab for the latest build.
+
+If you particularly want to build fonts manually on your own computer, you will need to install the [`yq` utility](https://github.com/mikefarah/yq). On OS X with Homebrew, type `brew install yq`; on Linux, try `snap install yq`; if all else fails, try the instructions on the linked page.
+
+Then:
+
+* `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.
+
+## License
 
 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:
+This license is copied below, and is also available with a FAQ at
 http://scripts.sil.org/OFL
+
+## Repository Layout
+
+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.