diff options
| -rw-r--r-- | CONTRIBUTING.md | 5 | ||||
| -rw-r--r-- | README.md | 10 |
2 files changed, 11 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 92a6a31e8..87077f3b4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -59,6 +59,7 @@ There are two ways of using the toolchain: - `dockermake` — a [prebuild Docker image](https://cloud.docker.com/u/rsms/repository/docker/rsms/inter-build) containing the complete toolchain is used. This is the easiest and quickest way to build Inter. Supports any platform that can run Docker, like Windows, macOS and Linux. - locally — setup the toolchain locally using `init.sh` and then build using make. Only supports macOS and Linux. + #### Using dockermake `dockermake` is simply `make` running in a docker image with the complete toolchain preinstalled. @@ -73,6 +74,10 @@ misc/fontbuild instancegen src/Inter.designspace SemiBoldItalic ... ``` +Note: If you have used dockermake in the past, run `docker pull rsms/inter-build:latest` to +ensure you have the latest version cached locally. + + #### Local toolchain Currently the toolchain has only been tested on macOS and Linux. All you need to have preinstalled is [Python 3](https://www.python.org/downloads/). @@ -84,8 +84,10 @@ Translating between EM units and pixels: There's a Figma workspace for glyphs, with configured metrics: ["Inter glyphs"](https://www.figma.com/file/RtScFU5NETY3j9E0yOmnW4gv/) -## See also +## Development -- [Contributing](CONTRIBUTING.md) -- [Compiling font files](CONTRIBUTING.md#compiling-font-files) -- [SIL Open Font License](LICENSE.txt) +For instructions on how to work with the source files and how to +[compile & build font files](CONTRIBUTING.md#compiling-font-files), +refer to [CONTRIBUTING.md](CONTRIBUTING.md). + +Inter is licensed under the [SIL Open Font License](LICENSE.txt) |