Update README.md

This commit is contained in:
Koen Lageveen 2020-10-10 13:27:09 +02:00 committed by GitHub
parent fce57bf5d1
commit ee80291e6c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 1 deletions

View File

@ -1,4 +1,32 @@
Programming Fonts
================
Test drive programming fonts [online in your browser](https://www.programmingfonts.org/).
Test drive programming fonts [online in your browser](https://www.programmingfonts.org/). The interactive counter part of the [Tumblr Blog](https://programmingfonts.tumblr.com).
ProgrammingFonts.org makes it easier to find monospaced fonts. All fonts in one place, with proper credits towards the creators. It's not a download portal, we don't track anything, it's strictly by nerds and designers for nerds and designers.
## Buy me a coffee
☕️👌🏻
Please feel free to make a little [donation via PayPal](https://paypal.me/pools/c/8tjP1zyUMT) towards the coffee that keeps this labour of love running. It's much appreciated!
## Project layout
- All information about the fonts is stored in [fonts.json](https://github.com/braver/programmingfonts/blob/gh-pages/fonts.json).
- Which adheres to [a schema](https://github.com/braver/programmingfonts/blob/gh-pages/fonts-schema.json).
- Font files are stored in [fonts/resources](https://github.com/braver/programmingfonts/tree/gh-pages/fonts/resources).
- We store only 4 variants (if available), in `.woff` format (if available): regular, italic, bold, bold+italic
- All font files (and directories) are normalized to lowercase, without `-mono` unless it's really part of the name.
- The license needs to allow serving in a website, or an agreement with the font creators needs to be made.
## Todo's
There are some limitations to the current approach. For instance, we only load the default set for each font. So, mostly:
- It' currently not possible to explore different weights (e.g. Source Code Pro Light).
- Open type alternatives for zero style, and other options (e.g. all the different variations possible with [Input Mono](https://input.fontbureau.com)) are not exposed.
- Available weights (variants) are not exposed and cannot be explored.
- Character set coverage and other valuable information, e.g. if a font has true italics, is not exposed.
- Background info on each font can usually be found in the blog and needs to be added to the `description` property for each font.
- I would be nice to include more commercial fonts. Creators need to eat to, and not all the best fonts are open source.