summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorRasmus Andersson <rasmus@notion.se>2020-05-18 18:47:33 +0300
committerRasmus Andersson <rasmus@notion.se>2020-05-18 18:47:33 +0300
commit717605c5cd173ff84690c2daf51c1b54589278d9 (patch)
tree7b87170a96baf0381539248444f9caa09e91fe06 /CONTRIBUTING.md
parent996c6f4f8137aa1a098f61471ec3a1ff6edc2cc6 (diff)
downloadinter-717605c5cd173ff84690c2daf51c1b54589278d9.tar.xz
tooling: Remove dockermake and fix a mkdir issue in init.sh. Closes #277
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md40
1 files changed, 2 insertions, 38 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 87077f3b4..f98e933f0 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -34,16 +34,6 @@ If these rules are not followed, generated styles will fail to build.
## Compiling font files
-There are three ways to generate font files (OTF, TTF, WOFF2, etc) from the sources files:
-
-- Using Inter's own build system: `dockermake` and locally (see ["Using the toolchain"](#using-the-toolchain))
-- Using the "export" feature in font editors like [Glyphs](https://glyphsapp.com/) or [RoboFont](http://robofont.com/)
-
-Exporting from font editors is a great alternative if you just want to test things out, but using Inter's own build system is the way to go for "production quality" font files. The rest of this section covers how to use Inter's own build system, aka _the toolchain_.
-
-
-### Using the toolchain
-
The Inter toolchain is a collection of programs setup to build everything
in a high-quality and reliable way. It can be fully automated and requires no
paid software.
@@ -51,35 +41,9 @@ paid software.
TL;DR: to make & test everything:
```
-./dockermake -j test
-```
-
-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.
-
-Simply edit source files and run `dockermake [make-arg ...]`
-
-Example:
-
-```
-$ ./dockermake -j Regular SemiBoldItalic
-misc/fontbuild instancegen src/Inter.designspace SemiBoldItalic
-...
+make -j test
```
-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/).
The first step is to initialize the toolchain itself:
@@ -90,7 +54,7 @@ The first step is to initialize the toolchain itself:
This will fetch, setup and configure everything needed to build and test Inter.
-> **—Important—** Run `init.sh` everytime you pull new changes to the source code or before pushing source code to a remote repository. `init.sh` may update the UFO source files and makefile, changes which may be required to be included in a source code change.
+> When running in a git repository, `init.sh` installs git hooks to automate running itself when you pull in new changes or switch branches.
We can now run `make` to build all font files: