|
13 | 13 |
|
14 | 14 | ## About
|
15 | 15 |
|
16 |
| -`fdiff` is a Python command line comparison tool for differences in the OpenType table data between font files. The tool provides cross-platform support on macOS, Windows, and Linux systems with a Python v3.6+ interpreter. |
| 16 | +`fdiff` is a Python command line comparison tool for assessment of differences in the OpenType table data between font files. The tool provides cross-platform support on macOS, Windows, and Linux systems with a Python v3.6+ interpreter. |
17 | 17 |
|
18 | 18 | <p align="center">
|
19 | 19 | <img src="https://raw.githubusercontent.com/source-foundry/fdiff/img/img/diff-example-crunch.png" width="500"/>
|
20 | 20 | </p>
|
21 | 21 |
|
22 | 22 | ## What it does
|
23 | 23 |
|
24 |
| -- Takes two font file path arguments for comparison |
| 24 | +- Takes two font file path (or URL for remote fonts) arguments for the font comparison |
25 | 25 | - Dumps OpenType table data in the fontTools library TTX format (XML)
|
26 | 26 | - Compares the OpenType table data across the two files using the unified diff format with 3 lines of surrounding context
|
27 | 27 |
|
@@ -79,16 +79,34 @@ $ pip3 install --ignore-installed -r requirements.txt -e ".[dev]"
|
79 | 79 |
|
80 | 80 | ## Usage
|
81 | 81 |
|
| 82 | +#### Local font files |
| 83 | + |
82 | 84 | ```
|
83 | 85 | $ fdiff [OPTIONS] [PRE-FONT FILE PATH] [POST-FONT FILE PATH]
|
84 | 86 | ```
|
85 | 87 |
|
86 |
| -By default, an uncolored unified diff is performed on the two files defined with the local file paths in the above command. |
| 88 | +#### Remote font files |
| 89 | + |
| 90 | +`fdiff` supports GET requests for publicly accessible remote font files. Replace the file path arguments with URL: |
| 91 | + |
| 92 | +``` |
| 93 | +$ fdiff [OPTIONS] [PRE-FONT FILE URL] [POST-FONT FILE URL] |
| 94 | +``` |
| 95 | + |
| 96 | +`fdiff` works with any combination of local and remote font files. For example, to compare a local post font file with a remote pre font file to assess local changes against a font file that was previously pushed to a remote, use the following syntax: |
| 97 | + |
| 98 | +``` |
| 99 | +$ fdiff [OPTIONS] [PRE-FONT FILE URL] [POST-FONT FILE FILE PATH] |
| 100 | +``` |
| 101 | + |
| 102 | +⭐ **Tip**: Remote git repository hosting services (like Github) support access to files on different git branches by URL. Use these repository branch URL to compare fonts across git branches in your repository. |
87 | 103 |
|
88 | 104 | ### Options
|
89 | 105 |
|
90 | 106 | #### Color diffs
|
91 | 107 |
|
| 108 | +Uncolored diffs are performed by default. |
| 109 | + |
92 | 110 | To view a colored diff in your terminal, include either the `-c` or `--color` option in your command:
|
93 | 111 |
|
94 | 112 | ```
|
|
0 commit comments