Skip to content

Commit 4cafd2d

Browse files
committed
[README.md] minor updates
1 parent 27d7985 commit 4cafd2d

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@
1313

1414
## About
1515

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.
1717

1818
<p align="center">
1919
<img src="https://raw.githubusercontent.com/source-foundry/fdiff/img/img/diff-example-crunch.png" width="500"/>
2020
</p>
2121

2222
## What it does
2323

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
2525
- Dumps OpenType table data in the fontTools library TTX format (XML)
2626
- Compares the OpenType table data across the two files using the unified diff format with 3 lines of surrounding context
2727

@@ -32,7 +32,7 @@
3232
- Modify the number of context lines displayed in the diff with the `-l` or `--lines` option
3333
- Display the first n lines of the diff output with the `--head` option
3434
- 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
3636

3737
Run `fdiff --help` to view all available options.
3838

@@ -69,7 +69,7 @@ $ pip3 install .
6969

7070
### Developer install from source
7171

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.
7373

7474
```
7575
$ git clone https://github.com/source-foundry/fdiff.git
@@ -115,19 +115,19 @@ $ fdiff --color [PRE-FONT FILE PATH] [POST-FONT FILE PATH]
115115

116116
#### Filter OpenType tables
117117

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:
119119

120120
```
121121
$ fdiff --include head,post [PRE-FONT FILE PATH] [POST-FONT FILE PATH]
122122
```
123123

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:
125125

126126
```
127127
$ fdiff --exclude glyf,OS/2 [PRE-FONT FILE PATH] [POST-FONT FILE PATH]
128128
```
129129

130-
**Do not include spaces** between the comma separated table name values!
130+
**Do not include spaces** between the comma-separated table name values!
131131

132132
#### Change number of context lines
133133

@@ -207,10 +207,10 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use
207207

208208
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.
209209

210-
### Third Party Licenses
210+
### Third-Party Licenses
211211

212212
#### CPython `difflib` library
213213

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.
215215

216216

0 commit comments

Comments
 (0)