diff options
| author | Rasmus Andersson <rasmus@notion.se> | 2019-09-07 22:56:11 +0300 |
|---|---|---|
| committer | Rasmus Andersson <rasmus@notion.se> | 2019-09-07 22:56:11 +0300 |
| commit | c4b6c10ed06d05d8dd701f20fedd91fabbcf17c0 (patch) | |
| tree | 03c394fbb7eba3a644f7a864bfb0d340f09d5bff /CONTRIBUTING.md | |
| parent | d8d4e0c26a82d5632b3833a27b372ff0a6d32d27 (diff) | |
| download | inter-c4b6c10ed06d05d8dd701f20fedd91fabbcf17c0.tar.xz | |
readme & contrib: info on building
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 5 |
1 files changed, 5 insertions, 0 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/). |