Skip to content

Commit

Permalink
Build sample images automatically and reference them in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
rimas-kudelis committed Oct 22, 2024
1 parent 28a2dca commit 1819b72
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
5 changes: 5 additions & 0 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,11 @@ jobs:
- name: diff
run: make diff
continue-on-error: true
- name: Generate images
run: |
make images
mkdir out/samples
cp documentation/*.png out/samples
- name: setup site
run: cp scripts/index.html out/index.html
- name: Deploy
Expand Down
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Jonova started out as a commercial product at [Fotonija](https://www.fotonija.lt

## Samples

![Sample Image](documentation/image1.png)
![Latin alphabet sample image](documentation/image2.png)
![Cyrillic alphabet sample image](documentation/image3.png)
![Greek alphabet sample image](documentation/image4.png)
![Sample Image](https://rimas-kudelis.github.io/jonova/samples/image1.png)
![Latin alphabet sample image](https://rimas-kudelis.github.io/jonova/samples/image2.png)
![Cyrillic alphabet sample image](https://rimas-kudelis.github.io/jonova/samples/image3.png)
![Greek alphabet sample image](https://rimas-kudelis.github.io/jonova/samples/image4.png)

## TODO

Expand All @@ -25,13 +25,12 @@ If you want to build fonts manually on your own computer:
* `make test` will run [FontBakery](https://github.com/rimas-kudelis/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://rimas-kudelis.github.io/jonova/.

## License

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
This license is available with a FAQ at https://openfontlicense.org

## Badges

Expand Down

0 comments on commit 1819b72

Please sign in to comment.