Skip to content

Commit e1db915

Browse files
committed
[README.md] initial draft of README
1 parent be4f4ea commit e1db915

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,28 @@
11
# set-unicoderange
2-
Python script to automatically set OpenType OS/2 table Unicode range bit flags
2+
3+
Python script to automatically set the [OpenType OS/2 table Unicode range bit flags](https://docs.microsoft.com/en-us/typography/opentype/spec/os2#ur).
4+
5+
## Dependencies
6+
7+
- Python 3.6+ interpreter
8+
- [fontTools Python package](https://github.com/fonttools/fonttools)
9+
10+
## Usage
11+
12+
Execute the `src/set-unicoderange.py` script on the command line with one or more font path arguments.
13+
14+
```
15+
$ python3 set-unicoderange.py [FONT PATH 1] (FONT PATH 2)...(FONT PATH n)
16+
```
17+
18+
The script detects the code points available in the font and automatically sets the OpenType OS/2.ulUnicodeRange bit flags 1 - 4.
19+
20+
### Example
21+
22+
```
23+
$ python3 set-unicoderange.py SomeFont-Regular.ttf
24+
```
25+
26+
## License
27+
28+
Apache License, Version 2.0. Please see [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)