From 53cc776baf35efbc26f07ccab58afefa4358208e Mon Sep 17 00:00:00 2001 From: Lukas Martinelli Date: Thu, 8 Dec 2016 09:39:09 +0100 Subject: [PATCH] Create README.md --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..5730e93e --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# Open Font Glyphs for GL Styles + +This project packages the most common free fonts with +[fontnik](https://github.com/mapbox/fontnik) so you don't have to +worry about [SDL](https://www.mapbox.com/blog/text-signed-distance-fields/) +and [gzipped PBFs](https://github.com/mapbox/mapbox-gl-js/issues/830). + +## Configure Mapbox GL Style JSON + +Your current Mapbox GL Style JSON configuration for `glyphs` will look like this. + +```javascript +"glyphs": "mapbox://fonts/openmaptiles/{fontstack}/{range}.pbf", +``` + +In order to use the fonts without a Mapbox API key edit your Mapbox GL Style JSON and change the endpoint for `glyphs` to `http://glfonts.lukasmartinelli.ch/fonts/{fontstack}/{range}.pbf`. + +```javascript +"glyphs": "http://fonts.openmaptiles.ch/{fontstack}/{range}.pbf", +``` + +## Supported Font Families + +The following fonts that are available in Mapbox Studio are supported. + +* Google Noto (patched by Klokan Technologies) +* Open Sans +* PT Sans +* Roboto +* Metropolis + +## Font License + +Please mind the license of the original fonts. +All fonts are either licensed under OFL or Apache.