summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorRasmus Andersson <rasmus@notion.se>2023-04-20 23:47:14 +0300
committerRasmus Andersson <rasmus@notion.se>2023-04-20 23:47:14 +0300
commitdd61fb169bbcf43d382ffbd03c7f6bfd9e97b18b (patch)
tree9ad7731b13cb0ed144ccde0992e63db5248278d2 /CONTRIBUTING.md
parent2c6c82317cfacc538173af819c75c7d40628afc9 (diff)
downloadinter-dd61fb169bbcf43d382ffbd03c7f6bfd9e97b18b.tar.xz
tooling: adds editable-ufos target to makefile for generating unprocessed UFOs
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index bca8a7d05..8e2f12a8e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -121,6 +121,22 @@ This font is stored and authored primarily in the [Glyphs](https://glyphsapp.com
`Inter.glyphspackage` directory (a macOS "bundle.")
+#### Editing UFO sources
+
+In some cases you might want to edit or inspect the fonts as UFOs.
+Inter is compiled to UFO as an intermediary step.
+
+The quickest path to UFOs is to run `make -j$(nproc) build/ufo/Inter-DisplayMedium.ufo`. Substitute "Inter-DisplayMedium.ufo" for any style.
+
+The quickest path to a designspace is to run `make -j$(nproc) build/ufo/Inter-Roman.designspace`
+
+However, if you indend to edit the fonts you probably want to use the `editable-ufos` make target instead:
+
+ make -j$(nproc) editable-ufos
+
+This generates all designspaces and UFOs, suitable for editing, in `build/ufo-editable/`. The main difference between `editable-ufos` and the intermediary UFOs in `build/ufo/` is that the "editable" ones does not have any processing applied to them: all components, anchors and paths are represented as-is in the original Glyphs source.
+
+
### Interactive Lab
This project comes with a simple web-based application for debugging and previewing the font. It's a very useful tool to have when working on the font.