Skip to content

Commit

Permalink
docs: update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelKreil committed Apr 9, 2024
1 parent ed4d585 commit 62f15ed
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,32 @@

free font glyphs for map rendering

## install, generate and package glyphs
## Install

```bash
git clone [email protected]:versatiles-org/versatiles-fonts.git
cd versatiles-fonts
npm install
npm run build
```

Generates a `dist/fonts.tar.gz` with all glyphs.
## Build

You can use the release file e.g. like this:
```bash
mkdir fonts
curl -L "https://github.com/versatiles-org/versatiles-fonts/releases/latest/download/fonts.tar.gz" | gzip -d | tar -xf - -C ./fonts/
npm run build
```

- Generates a `dist/fonts.tar.gz` with all glyphs.
- Also generates `dist/{font_family}.tar.gz` for each font family.

## Fonts

- [Metropolis](https://fontsarena.com/metropolis-by-chris-simpson/), by Chris Simpson, [Public Domain](https://wiki.creativecommons.org/wiki/public_domain)
- [Fira Sans](https://fonts.google.com/specimen/Fira+Sans), by Chris Apostrophe, [OFL](https://en.wikipedia.org/wiki/SIL_Open_Font_License)
- [Lato](https://fonts.google.com/specimen/Lato), by Łukasz Dziedzic, [OFL](https://en.wikipedia.org/wiki/SIL_Open_Font_License)
- [Libre Baskerville](https://fonts.google.com/specimen/Libre+Baskerville), by Impallari Type, [OFL](https://en.wikipedia.org/wiki/SIL_Open_Font_License)
- [Merriweather Sans](https://fonts.google.com/specimen/Merriweather+Sans), by Sorkin Type, [OFL](https://en.wikipedia.org/wiki/SIL_Open_Font_License)
- [Noto Sans](https://fonts.google.com/noto/specimen/Noto+Sans), by Google, [OFL](https://en.wikipedia.org/wiki/SIL_Open_Font_License)
- [Nunito](https://fonts.google.com/specimen/Nunito), by Vernon Adams, Cyreal and Jacques Le Bailly, [OFL](https://en.wikipedia.org/wiki/SIL_Open_Font_License)
- [Open Sans](https://www.opensans.com), by Steve Matteson, [OFL](https://en.wikipedia.org/wiki/SIL_Open_Font_License)
- [PT Sans](https://company.paratype.com/pt-sans-pt-serif), Alexandra Korolkova, Olga Umpelova, Vladimir Yefimov, [OFL](https://en.wikipedia.org/wiki/SIL_Open_Font_License)
- [Roboto](https://fonts.google.com/specimen/Roboto), Christian Robertson, [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0)
- [Lato](https://fonts.google.com/specimen/Lato), Lukasz Dziedzic, [OFL](https://en.wikipedia.org/wiki/SIL_Open_Font_License)
- [Libre Baskerville](https://fonts.google.com/specimen/Libre_Baskerville), Pablo Impallari, Rodrigo Fuenzalida, [OFL](https://en.wikipedia.org/wiki/SIL_Open_Font_License)
- [Merriweather](https://fonts.google.com/specimen/Merriweather), The Merriweather Project Authors, [OFL](https://en.wikipedia.org/wiki/SIL_Open_Font_License)
- [Nunito](https://fonts.google.com/specimen/Nunito), The Nunito Project Authors [OFL](https://en.wikipedia.org/wiki/SIL_Open_Font_License)
- [Source Sans Pro](https://fonts.google.com/specimen/Source_Sans_Pro), Adobe Systems Incorporated [OFL](https://en.wikipedia.org/wiki/SIL_Open_Font_License)
- [PT Sans](https://fonts.google.com/specimen/PT+Sans), by ParaType, [OFL](https://en.wikipedia.org/wiki/SIL_Open_Font_License)
- [Roboto](https://fonts.google.com/specimen/Roboto), by Christian Robertson, [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0)
- [Source Sans 3](https://fonts.google.com/specimen/Source+Sans+3), by Paul D. Hunt, [OFL](https://en.wikipedia.org/wiki/SIL_Open_Font_License)

0 comments on commit 62f15ed

Please sign in to comment.