Skip to content

Commit 8a9b3f5

Browse files
committed
Add ReadMe file
1 parent 09841ce commit 8a9b3f5

File tree

1 file changed

+59
-2
lines changed

1 file changed

+59
-2
lines changed

README.md

Lines changed: 59 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,59 @@
1-
# HMI-Font-Pack
2-
Selection of open-source fonts that can be used in Nextion / TJC HMI projects
1+
HMI Font Pack
2+
=============
3+
4+
5+
About
6+
-----
7+
8+
This HMI Font Pack contains a large selection of open-source fonts that can be used in Nextion / TJC HMI projects.
9+
The Nextion Editor and TJC USART Editor use a propriatary .zi font format.
10+
Now you can add a wide selection of quality fonts to your project in seconds.
11+
12+
In the font pack there are dozens of fonts for each supported language (codepage) in different fontsizes.
13+
Only Regular styles are included in this release.
14+
15+
The .zi files are version 5 and support anti-aliasing and varable width fonts. Version 0.55 or higher of the Nextion / USART HMI Editor is needed to use these font files.
16+
17+
18+
Open Source Fonts
19+
-----------------
20+
21+
- Most of the fonts are from the Google Fonts project: https://github.com/google/fonts
22+
- Additional Noto CJK fonts are from: https://github.com/googlefonts/noto-cjk
23+
24+
Additional OFL fonts can be included upon request.
25+
26+
27+
Version History
28+
---------------
29+
30+
| Date | Version | Description
31+
|:----------:|:-------:|----------------
32+
| 2019-08-19 | 0.0.1 | Initial Release
33+
34+
35+
License
36+
-------
37+
38+
Most of the fonts in the HMI Font Pack use the SIL Open Font License, v1.1. Some fonts use the Apache 2 license. The Ubuntu fonts use the Ubuntu Font License v1.0.
39+
40+
The HMI Font Pack is licensed under the same open license as the source fonts.
41+
The Reserved Font Names are copyrighted by their respective owners.
42+
Each HMI font is prepended with the text "HMI" to indicate a derived work and has the .zi extension.
43+
No changes were made to the original .ttf / .otf files.
44+
45+
There is a subfolder per license type:
46+
- OFL : SIL Open Font License, Version 1.1
47+
- UFL : Ubuntu Font License, Version 1.0
48+
- Apache2 : Apache License, Version 2.0
49+
50+
The original license files for each source font are retained in each font directory.
51+
Carefully read the license file before including the HMI font files into your HMI projects.
52+
53+
54+
Disclaimer
55+
----------
56+
57+
The HMI font files are automatically generated by an early release version of [ZiLib](https://github.com/hagronnestad/nextion-font-editor/tree/master/NextionFontEditor/ZiLib). No guarantees are made towards the usability or suitablilty of these font files in your HMI projects.
58+
59+
Please open an issue if you find an error, bug or mistake.

0 commit comments

Comments
 (0)