summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRasmus Andersson <rasmus@notion.se>2017-08-22 20:23:13 +0300
committerRasmus Andersson <rasmus@notion.se>2017-08-22 20:28:57 +0300
commit797757bde2e305e035bcba65a93993ecd0716398 (patch)
treeeeac6c7d62e6ea953a98d7d310fd07e93dd310a2 /README.md
parentf89b420bc07ce7a1e9b4aae47afbd16901c46edd (diff)
downloadinter-797757bde2e305e035bcba65a93993ecd0716398.tar.xz
adds CONTRIBUTING.md and license info for fallback glyph contours in src
Diffstat (limited to 'README.md')
-rw-r--r--README.md142
1 files changed, 3 insertions, 139 deletions
diff --git a/README.md b/README.md
index 8654874bb..6966a4df3 100644
--- a/README.md
+++ b/README.md
@@ -65,143 +65,7 @@ Translating between EM units and pixels:
There's a Figma workspace for glyphs, with configured metrics: ["Interface glyphs"](https://www.figma.com/file/RtScFU5NETY3j9E0yOmnW4gv/Interface-glyphs)
-## Contributing
+## See also
-By contributing work to the Interface font project you agree to have all work
-contributed becoming the intellectual property of the Interface font project as
-described by [SIL Open Font License, Version 1.1](http://scripts.sil.org/OFL)
-
-### Building
-
-Prerequisites:
-
-- Python 2.7 with pip (you get pip with `brew install python`)
-- [virtualenv](https://virtualenv.pypa.io/)
-
-```
-$ ./init.sh
-```
-
-This will generate makefile support, dependencies required by the toolchain, etc.
-At the end, the script prints instructions for how to activate `virtualenv`.
-As a convenience, you can also source init.sh to activate virtualenv.
-
-We can now run `make` to build all font files:
-
-```
-$ make
-```
-
-Or just specific styles:
-
-```
-$ make Regular BoldItalic
-```
-
-Or all fonts but only TrueType format (no web file formats):
-
-```
-$ make all_ttf
-```
-
-Or just specific styles and formats:
-
-```
-# Regular in all formats, BoldItalic in only TrueType format
-$ make Regular BoldItalic_ttf
-```
-
-You can also specify specific style + file format to `make` through `build/Interface-STYLE.FORMAT`.
-E.g.
-
-- `make build/Interface-MediumItalic.eot`
-- `make build/Interface-Bold.woff2`
-- `make build/Interface-Regular.ttf`
-- `...`
-
-All resulting font files are written to the `build` directory with `Interface-` as the filename prefix.
-
-Note: Making all files takes a considerable amount of time.
-It's a CPU and I/O intensive task to compile the fonts and so the build system has been setup to
-be able to run many jobs in parallel. Therefore it's recommended to pass the [`-j` flag to make](https://www.gnu.org/software/make/manual/html_node/Parallel.html) and
-optionally pipe the fairly verbose output to /dev/null, e.g. `make -j 8 >/dev/null`.
-
-
-### Editing
-
-This font is stored and authored in the [Unified Font Object (UFO)](http://unifiedfontobject.org/) file format and can be edited by many different software, some free. However, it's only been "tested" with [RoboFont](http://robofont.com/) which is a popular commercial font editor. There's a 30 day fully-functional free trial version of the app, so you can use it for smaller contributions without needing to buy a RoboFont license.
-
-To make life easier for you, configure RoboFont's settings like this:
-
-- Set the grid to 128 units. This means that each grid square equals one pixel at 2x scale.
-- Set "Snap points to" to a reasonably high number that's a power-of-two, like 8.
-- Set "SHIFT increment" to 16
-- Set "CMD SHIFT increment" to 128
-
-When you've made an edit, simply save your changes and run make:
-
-```
-$ make
-```
-
-*For quick turnaround, consider:*
-
-- Build and test only the "Regular" style.
-- Use `misc/notify` to get desktop notifications on builds so that you don't have to sit and wait looking at the terminal while it's building.
-
-E.g. `misc/notify make Regular`
-
-See ["Building"](#Building) for more details.
-
-
-### Preview & debug
-
-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.
-
-- Comes with a large body of sample text data (which is also editable.)
-- Provides samples of the most common latin-script pairs, useful for kerning.
-- Provides samples of words ordered by commonality in latin scripts with a
- preference for English (accessible via common-pair samples.)
-- Can show the complete repertoire of the fonts, with correct glyph order and
- even RoboFont color labels ("marks").
-- Controls for basic font properties like family, weight, italic, size,
- line-height, letter-spacing, etc.
-- Controls for a lot of font features like ligature sets, contextual alternates,
- alternate numerics, etc.
-- Controls for web-browser text features like `captialize`, `uppercase`,
- `lowercase`, etc.
-- Ability to compare Interface side-by-side with other fonts.
-
-![Preview app screenshot](docs/res/preview-app.png)
-
-The following will start a local web server (which is only accessable from your local computer; not the internet) that serves the debug-and-preview app:
-
-```
-$ docs/serve.sh &
-```
-
-You can now visit `http://localhost:2015/lab/`.
-After you rebuild some font files, reload the web page to refresh fonts.
-
-
-## FAQ
-
-> Do I need RoboFont?
-
-No, you don't. To build font files, all you need is Python. To edit the font files, you need something that can edit UFO files (like [RoboFont](http://robofont.com/) or a text editor.)
-
-
-> `KeyError: 'Lj'` when building
-
-This probably means that you need to run `./init.sh` to setup the case-sensitive virtual file system mount that is needed by the font build system. Unfortunately the toolchain used (which is the same as for Roboto) requires not only a case-preserving file system, but also a case-sensitive one.
-
-
-> `ImportError: No module named robofab.objects.objectsRF`
-
-Python virtualenv not configured. Run `. init.sh`
-
-
-> `make: *** No rule to make target ...`
-
-Run `./init.sh` to update the generated makefile.
+- [Contributing](CONTRIBUTING.md)
+- [SIL Open Font License](LICENSE.txt)