Skip to content

Commit 95554ab

Browse files
committed
Update project's README to mention the patch-hack.sh script
1 parent 614e144 commit 95554ab

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You may view images of the alternate designs in the README.md files at the top l
1818

1919
- Download the [Hack typeface source](https://github.com/source-foundry/Hack/archive/master.zip).
2020
- Download the `*.glif` source files from the alt-hack repository that you would like to use as replacements in the Hack source.
21-
- Overwrite the existing Hack `*.glif` files for your selected Unicode code points with the alt-hack `*.glif` files (replacements in alt-hack have the same file paths as those in default source).
21+
- Overwrite the existing Hack `*.glif` files for your selected Unicode code points with the alt-hack `*.glif` files (replacements in alt-hack have the same file paths as those in default source). You can use the included `patch-hack.sh` script to automate this operation – see instructions within the script itself.
2222
- Modify existing manual hinting adjustments for any files that you replace (see [detailed instructions](#eliminate-existing-manual-instruction-sets-for-alternate-glyphs-if-present) below)
2323
- Build new Hack fonts using the simple make based build approach in the [build documentation](https://github.com/source-foundry/Hack/blob/master/docs/BUILD.md).
2424

@@ -41,7 +41,9 @@ The glyph design source files live in the `glyphs` subdirectory within each of t
4141
Download the `*.glif` files in the regular, bold, italic, and bolditalic directories from the alt-hack repository for each replacement that you want to make in the Hack source. The alternate style source files have the same file path as we use in the Hack source. The `*.glif` design source files are intended to be used as direct replacements for the existing default source files.
4242

4343
#### Overwrite existing source files
44-
Copy the alternate glyph source files for the appropriate font variants (i.e. regular, bold, italic, bold italic) from this repository into the corresponding `glyphs` directory of the Hack UFO source for the respective variant. This should overwrite an existing file in that directory. Please note that the alternate files for each variant have the same file path. Please confirm that you are overwriting an existing file with a new file that is of the appropriate variant type.
44+
You can use the included `patch-hack.sh` script to copy over your desired glyph modifications over into the Hack source repository. See instructions in the script itself.
45+
46+
Alternatively, you can do the copying manually. Copy the alternate glyph source files for the appropriate font variants (i.e. regular, bold, italic, bold italic) from this repository into the corresponding `glyphs` directory of the Hack UFO source for the respective variant. This should overwrite an existing file in that directory. Please note that the alternate files for each variant have the same file path. Please confirm that you are overwriting an existing file with a new file that is of the appropriate variant type.
4547

4648
#### Eliminate existing manual instruction sets for alternate glyphs (if present)
4749
Some of the glyphs in the Hack sets include manual changes to the ttfautohint automated instruction sets ("hints"). These must be eliminated if you replace an existing glyph in the main Hack sets with a stylistic alternate from this repository or your build will fail (or create undesirable rendering changes that are not tuned for the alternate glyph).

0 commit comments

Comments
 (0)