fonts/nerd-fonts
1
0
Fork 0
mirror of https://github.com/ryanoasis/nerd-fonts.git synced 2024-12-01 16:55:57 +02:00
Code Issues Releases Activity

Update documentation

Browse Source
This commit is contained in:
Fini Jastrow 2022-09-19 18:11:48 +02:00
parent 3fd15de2a3
commit b255bc1d71
3 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
bin/scripts/README.md
View File

@ -13,12 +13,13 @@ Note: Usually you need to call the scripts in this directory while actually bein
* `generate-fontconfig.sh`: Generates font configuration to enable use of unpatched fonts with Symbols Only Nerd Font [1]
* `generate-font-image-previews.sh`: Generates the preview images for `nerdfonts.com` (i.e. gh-pages) [3]
* `generate-glyph-info-from-set.py`: Generate the `i_xxx.sh` file from a glyph source (font) file, if the glyphs are named correctly [4]
* `generate-original-source.py`: Generate `original-source.otf` from single glyph svgs. [3]
* `generate-original-source.py`: Generate `original-source.otf` from single glyph svgs. [5]
* `get-font-names-from-json.sh`: Helper to setup the CI font matrix from `data/fonts.json` [1]
* `gotta-patch-em-all-font-patcher!.sh`: Patch one or more fonts 'complete' with and without `mono` and with and without `windows compat` [1]
* `Hack/`: Special additional post patching script for Hack, invoked via Hack's `config.cfg` (not used when self-patching)
* `lib/`: See its own README
* `name_parser/`: Suite to set up sane Family and SubFamily names, used by `font-patcher` (on demand)
* `optimize-original-source.sh`: Run all icons in `src/svgs` through inkscape to simplify (remove nodes and edges) [5]
* `release.sh`: Rough process how a release is created, not used (see `.github/workflows/release.yml`)
* `standardize-and-complete-readmes.sh` [1]
* `test-fonts.sh`: Print-to-debug all glyphs we patch in [4]
@ -31,4 +32,5 @@ Note: Usually you need to call the scripts in this directory while actually bein
[2] Used by CI (github docker-release workflow)
[3] To be used manually (sigh)
[4] To be used manually
[5] Used by CI (github packsvgs workflow)
[x] Probably not used by anything

8
src/glyphs/README.md Normal file
View File

@ -0,0 +1,8 @@
### Contents
This directory contains all the glyphs (glyph sets) that the `font-patcher` puts into the fonts.
If a icon font here is updated, do not forget to update the database file in `bin/script/libs`.
The 'Seti and Original' icons (in `original-source.otf`) is automatically generated from the glyphs in `src/svgs`.
Do not edit and commit changes to that font directly.

11
src/svgs/README.md Normal file
View File

@ -0,0 +1,11 @@
### Contents
These are the source glyphs for the 'Seti and Original' icon set.
`generate-original-source.py` generates a font file from all these individual glyphs. That font is then used for the actual patching process.
The codepoints and names of the icons here have to be put into `icons.tsv`.
If you push a new svg-file here it will be run through Inkscape 'simplify-path'! Keep that in mind.
The simplification is also automated for every push via `optimize-original-source.sh`.