Skip to content

Commit d7d8bef

Browse files
committed
README: Clarify build process w/new Makefiles
1 parent 27bb814 commit d7d8bef

File tree

1 file changed

+28
-9
lines changed

1 file changed

+28
-9
lines changed

README.md

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,30 +60,49 @@ pip install ufo-extractor defcon fez-language fonttools afdko
6060

6161
### Needed software
6262

63-
* GNU Parallel
63+
* GNU [`parallel`](https://www.gnu.org/software/parallel/) (requires a Perl interpreter)
6464
* GNU `bash`, `find`, `make`, and `sed`†
65-
* MFEKmetadata‡ (used to build arrows)
66-
* MFEKstroke‡ (before v1.2 only used to build a few font features but now used to build every font)
67-
* MFEKglif‡ (to edit glyphs)
68-
* MFEKglif2svg⹋
65+
* [MFEKmetadata](https://github.com/MFEK/metadata)‡ (used to build arrows)
66+
* [MFEKstroke](https://github.com/MFEK/stroke)‡ (before v1.2 only used to build a few font features but now used to build every font)
67+
* [MFEKglif](https://github.com/MFEK/glif)‡ (to edit glyphs)
68+
* [MFEKglif2svg](https://github.com/MFEK/glif2svg)‡
6969
* [Xidel](https://github.com/benibela/xidel)
7070

7171
#### For specimens
72-
* SILE
73-
* PDFtk
74-
* ImageMagick
72+
* [SILE](https://github.com/sile-typesetter/sile)
73+
* [PDFtk](https://gitlab.com/pdftk-java/pdftk)
74+
* [ImageMagick](https://imagemagick.org/index.php)
7575
* hb-view (`harfbuzz`)
7676
* ftdump (`freetype2-demos`)
7777

7878
#### For physics
7979
FRB American Cursive v2 optionally requires a physics simulator to figure out the correct placement of its stroke numbers. This saves a lot of time for the designer, but can be a bit cumbersome to set up, so building is possible without it. v2 uses the Java version of [Processing](https://processing.org/) plus [toxiclibs](https://toxiclibs.org) as its physics engine; you'll also need to install [geomerative](http://www.ricardmarxer.com/geomerative/geomerative-39.zip) to `sketchbook/libraries`. This might change in future releases. For your convenince, my entire Processing `sketchbook/` directory can be downloaded from [ctrlcctrlv/FRBAmericanCursive-processing-sketchbook](https://github.com/ctrlcctrlv/FRBAmericanCursive-processing-sketchbook).
8080

8181
<sub>&dagger; These should be standard on most Linux distributions and on Windows under MSYS2.</sub>
82-
<sub>&Dagger; These are Rust projects and need to be compiled by <kbd>cargo</kbd> and installed into your <kbd>PATH</kbd>.</sub>
82+
<sub>&Dagger; These are Rust projects and need to be compiled by <kbd>cargo build --release</kbd> and installed into your <kbd>PATH</kbd>.</sub>
8383
<sub>Must be installed to `$PATH` as `glif2svg-rs`.</sub>
8484

8585
### Build process
8686

87+
The Makefiles in v2 are a bit unique as we want to build a Print and a Cursive with near-identical steps.
88+
89+
Calling:
90+
91+
```bash
92+
make -j1 all-fonts
93+
```
94+
95+
Will build both (takes a long time even if everything is right.)
96+
97+
To build one or the other:
98+
99+
```bash
100+
make -f Makefile.PRINT
101+
```
102+
```bash
103+
make -f Makefile.CURSIVE
104+
```
105+
87106
On `make`, this is the general flow:
88107

89108
#### `make regen`

0 commit comments

Comments
 (0)