Skip to content

Commit 302a336

Browse files
committed
updated README
1 parent 4a8ab90 commit 302a336

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## font-line [![Build Status](https://travis-ci.org/source-foundry/font-line.svg?branch=master)](https://travis-ci.org/source-foundry/font-line) [![Build status](https://ci.appveyor.com/api/projects/status/2s4725o5mxh2298c/branch/master?svg=true)](https://ci.appveyor.com/project/chrissimpkins/font-line/branch/master) [![codecov.io](https://codecov.io/github/source-foundry/font-line/coverage.svg?branch=master)](https://codecov.io/github/source-foundry/font-line?branch=master)
22

33

4-
### About
5-
font-line is a libre, open source command line tool for OpenType vertical metrics reporting and command line based font line spacing modifications. It currently supports `.ttf` and `.otf` font builds.
4+
## About
5+
font-line is a libre, open source command line tool for OpenType vertical metrics reporting and command line based font line spacing modifications. It supports `.ttf` and `.otf` font builds.
66

7-
### Contents
7+
## Contents
88

99
- [Install Guide](https://github.com/source-foundry/font-line#install)
1010
- [Usage](https://github.com/source-foundry/font-line#usage)
@@ -13,24 +13,24 @@ font-line is a libre, open source command line tool for OpenType vertical metric
1313
- [Changelog](https://github.com/source-foundry/font-line/blob/master/CHANGELOG.md)
1414
- [License](https://github.com/source-foundry/font-line/blob/master/docs/LICENSE)
1515

16-
### Quickstart
16+
## Quickstart
1717

1818
- Install: `$ pip install font-line`
1919
- Metrics Report: `$ font-line report [font path]`
2020
- Modify line spacing: `$ font-line percent [integer %] [font path]`
2121
- Help: `$ font-line --help`
2222

23-
### Install
23+
## Install
2424

25-
font-line is built with Python and can be used on systems with Python 2.7+ and Python 3.3+ interpreters, including current releases of pypy and pypy3. You can verify your installed Python version on the command line with the command:
25+
font-line is built with Python and is tested with Python 2.7 and Python 3.5+ interpreters. You can verify your installed Python version on the command line with the command:
2626

2727
```
2828
$ python --version
2929
```
3030

3131
Use either of the following methods to install font-line on your system.
3232

33-
#### pip Install
33+
### pip Install
3434

3535
The latest font-line release is available through the Python Package Index and can be installed with pip:
3636

@@ -40,7 +40,7 @@ $ pip install font-line
4040

4141
To upgrade to a new version of font-line after a pip install, use the command `pip install --upgrade font-line`.
4242

43-
#### Download Project Repository and Install
43+
### Download Project Repository and Install
4444

4545
The current repository version (which may be ahead of the PyPI release) can be installed by [downloading the repository](https://github.com/source-foundry/font-line/archive/master.zip) or cloning it with git:
4646

@@ -54,9 +54,9 @@ Navigate to the top level repository directory and enter the following command:
5454
$ python setup.py install
5555
```
5656

57-
Follow the same instructions to upgrade to a new version of the application if you elect to install with this approach.
57+
Follow the same instructions to upgrade to a new version of the application if you install with this approach.
5858

59-
### Usage
59+
## Usage
6060

6161
font-line works via sub-commands to the `font-line` command line executable. The following sub-commands are available:
6262

@@ -65,7 +65,7 @@ font-line works via sub-commands to the `font-line` command line executable. Th
6565

6666
Usage of these sub-commands is described in detail below.
6767

68-
#### Vertical Metrics Reporting
68+
### Vertical Metrics Reporting
6969

7070
The following OpenType vertical metrics values and calculated values derived from these data are displayed with the `report` sub-command:
7171

@@ -83,7 +83,7 @@ The following OpenType vertical metrics values and calculated values derived fro
8383
- [head] yMax
8484
- [head] yMin
8585

86-
##### `report` Sub-Command Usage
86+
#### `report` Sub-Command Usage
8787

8888
Enter one or more font path arguments to the command:
8989

@@ -97,7 +97,7 @@ Here is an example of the report generated with the Hack typeface file `Hack-Reg
9797
$ font-line report Hack-Regular.ttf
9898
```
9999

100-
##### Example Font Vertical Metrics Report
100+
#### Example Font Vertical Metrics Report
101101
```
102102
=== Hack-Regular.ttf ===
103103
Version 3.001; 379b3ad6d-dev
@@ -146,11 +146,11 @@ $ font-line report TheFont.ttf > font-report.txt
146146

147147
You can modify the `font-report.txt` file path above to the file path string of your choice.
148148

149-
#### Vertical Metrics Modifications
149+
### Vertical Metrics Modifications
150150

151151
font-line supports automated line spacing modifications to a user-defined percentage of the units per em metric. This value will be abbreviated as UPM below.
152152

153-
##### `percent` Sub-Command Usage
153+
#### `percent` Sub-Command Usage
154154

155155
Enter the desired percentage of the UPM as the first argument to the command. This should be *entered as an integer value*. Then enter one or more font paths to which you would like to apply your font metrics changes.
156156

@@ -170,7 +170,7 @@ The original font file is preserved in an unmodified version and the modified fi
170170

171171
You can inspect the vertical metrics in the new font file with the `report` sub-command (see Usage above).
172172

173-
##### Details of Font Metrics Changes with `percent` Sub-Command
173+
#### Details of Font Metrics Changes with `percent` Sub-Command
174174

175175
The interpretation and display of these multiple vertical metrics values is platform and application dependent. [There is no broadly accepted "best" approach](https://github.com/source-foundry/font-line/issues/2). As such, font-line attempts to preserve the original metrics design in the font when modifications are made with the `percent` sub-command.
176176

@@ -219,17 +219,17 @@ Where metrics are defined as:
219219

220220
Note that the internal leading modifications are split evenly across [hhea] Ascent & Descent values, and across [OS/2] WinAscent & WinDescent values. We add half of the new [OS/2] TypoLineGap value to the original [OS/2] TypoAscender or TypoDescender in order to define these new metrics properties. The [hhea] linegap value is always defined as zero.
221221

222-
#### Important
222+
### Important
223223

224224
The newly defined vertical metrics values can lead to clipping of glyph components if not properly defined. There are no tests in font-line to provide assurance that this does not occur. We assume that the user is versed in these issues before use of the application and leave this testing to the designer / user before the modified fonts are used in a production setting.
225225

226226

227-
### Issue Reporting
227+
## Issue Reporting
228228

229229
Please [submit a new issue report](https://github.com/source-foundry/font-line/issues/new) on the project repository.
230230

231231

232-
### Acknowledgments
232+
## Acknowledgments
233233

234234
font-line is built with the fantastic [fontTools](https://github.com/behdad/fonttools) Python library.
235235

0 commit comments

Comments
 (0)