|
13 | 13 |
|
14 | 14 | ## About
|
15 | 15 |
|
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. |
| 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 for local and remote font diffs on macOS, Windows, and GNU/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 (or URL for remote fonts) arguments for the font comparison |
| 24 | +- Takes two font file path arguments (or URL for remote fonts) 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 |
|
|
32 | 32 | - Modify the number of context lines displayed in the diff with the `-l` or `--lines` option
|
33 | 33 | - Display the first n lines of the diff output with the `--head` option
|
34 | 34 | - Display the last n lines of the diff output with the `--tail` option
|
35 |
| - |
| 35 | +- Execute the diff with an external diff tool using the `--external` option |
36 | 36 |
|
37 | 37 | Run `fdiff --help` to view all available options.
|
38 | 38 |
|
@@ -69,7 +69,7 @@ $ pip3 install .
|
69 | 69 |
|
70 | 70 | ### Developer install from source
|
71 | 71 |
|
72 |
| -The following approach installs the project and associated optional developer dependencies so that source changes are available without the need for re-installation. |
| 72 | +The following approach installs the project and associated optional developer dependencies, so that source changes are available without the need for re-installation. |
73 | 73 |
|
74 | 74 | ```
|
75 | 75 | $ git clone https://github.com/source-foundry/fdiff.git
|
@@ -115,19 +115,19 @@ $ fdiff --color [PRE-FONT FILE PATH] [POST-FONT FILE PATH]
|
115 | 115 |
|
116 | 116 | #### Filter OpenType tables
|
117 | 117 |
|
118 |
| -To include only specified tables in your diff, use the `--include` option with a comma separated list of table names: |
| 118 | +To include only specified tables in your diff, use the `--include` option with a comma-separated list of table names: |
119 | 119 |
|
120 | 120 | ```
|
121 | 121 | $ fdiff --include head,post [PRE-FONT FILE PATH] [POST-FONT FILE PATH]
|
122 | 122 | ```
|
123 | 123 |
|
124 |
| -To exclude specified tables in your diff, use the `--exclude` option with a comma separated list of table names: |
| 124 | +To exclude specified tables in your diff, use the `--exclude` option with a comma-separated list of table names: |
125 | 125 |
|
126 | 126 | ```
|
127 | 127 | $ fdiff --exclude glyf,OS/2 [PRE-FONT FILE PATH] [POST-FONT FILE PATH]
|
128 | 128 | ```
|
129 | 129 |
|
130 |
| -**Do not include spaces** between the comma separated table name values! |
| 130 | +**Do not include spaces** between the comma-separated table name values! |
131 | 131 |
|
132 | 132 | #### Change number of context lines
|
133 | 133 |
|
@@ -207,10 +207,10 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use
|
207 | 207 |
|
208 | 208 | Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
|
209 | 209 |
|
210 |
| -### Third Party Licenses |
| 210 | +### Third-Party Licenses |
211 | 211 |
|
212 | 212 | #### CPython `difflib` library
|
213 | 213 |
|
214 |
| -This project distributes a modified version of third party source code from the [Python programming language standard library](https://github.com/python/cpython). The `difflib.py` v3.7.4 module is Copyright © 2001-2019 Python Software Foundation; All Rights Reserved. This source is modified and distributed in this project under the [PSF LICENSE AGREEMENT FOR PYTHON 3.7.4](https://github.com/source-foundry/fdiff/blob/master/lib/fdiff/thirdparty/PYTHON_LICENSE). The module is renamed to `fdifflib.py` to distinguish it from the upstream source and modifications made here are documented in comments at the head of the module. |
| 214 | +This project distributes a modified version of third party source code from the [Python programming language standard library](https://github.com/python/cpython). The `difflib.py` v3.7.4 module is Copyright © 2001-2019 Python Software Foundation; All Rights Reserved. This source is modified and distributed in this project under the [PSF LICENSE AGREEMENT FOR PYTHON 3.7.4](https://github.com/source-foundry/fdiff/blob/master/lib/fdiff/thirdparty/PYTHON_LICENSE). The module is renamed to `fdifflib.py` to distinguish it from the upstream source, and modifications made here are documented in comments at the head of the module. |
215 | 215 |
|
216 | 216 |
|
0 commit comments