summaryrefslogtreecommitdiff
path: root/src/README.md
diff options
context:
space:
mode:
authorRasmus Andersson <rasmus@notion.se>2018-09-04 05:18:43 +0300
committerRasmus Andersson <rasmus@notion.se>2018-09-04 05:18:43 +0300
commit582504497eee9d1a5d202ec6d1a2c929f376ccdf (patch)
treec379d83030b2770b5501f215683f6bd6fcb02912 /src/README.md
parent7833ac28f8120c26d20a43582924a34961ad4e2d (diff)
downloadinter-582504497eee9d1a5d202ec6d1a2c929f376ccdf.tar.xz
add readme to src dir
Diffstat (limited to 'src/README.md')
-rw-r--r--src/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/README.md b/src/README.md
new file mode 100644
index 000000000..1a015d06f
--- /dev/null
+++ b/src/README.md
@@ -0,0 +1,14 @@
+# Source files
+
+You either edit the .glyphs file OR you edit the UFO files.
+Any edits to the .glyphs file will overwrite changes to UFO files,
+but not vice versa.
+
+`Inter-UI.glyphs` is the main combined master file.
+Editing this and running `make` patches and potentially overwrites changes to
+the UFO files and replaces `Inter-UI.desigspace`.
+
+`Inter-UI.desigspace` and `Inter-UI*.ufo` are generated from the .glyphs file
+but can be edited themselves. For instance, if you fork this project and
+prefer to work with UFOs, you can do that and simply ignore the .glyphs file.
+