linux/nerd-fonts
0
0
Fork 0
mirror of https://github.com/ryanoasis/nerd-fonts.git synced 2024-09-19 09:51:48 +02:00
Code Issues Projects Releases Wiki Activity
nerd-fonts/bin/scripts/README.md

45 lines
3.4 KiB
Markdown
Raw Normal View History

Add documentation to bin/scripts/ directory Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2022-09-16 11:15:26 +02:00
### Contents
Note: Usually you need to call the scripts in this directory while actually being in this directory (i.e. `pwd = .../nerd-fonts/bin/scripts`).
* `archive-font-patcher.sh`: Archives the font patcher script and subscripts and the required source glyph files [1]
* `archive-fonts.sh`: Creates the release zip file of one or more font(s) from existing `patched-fonts/` content [1]
* `data/`: Contains plain text files used to generate the CSS and cheat sheet files
* `data/sankey/`: Contains instructions on how to create the sankey glyph table manually [3]
* `docker-entrypoint.sh`: This script is packaged into the docker container and is usually used to start patching [2]
CI: Add new workflow to create all casks [skip-ci] Now we can create the casks of some specific release ('latest' in this case) at will, based purely on the artifact files and on nothing in the repo. We do not even need to fetch the repo. This is still some kind of WIP, because we do not have the secrets and not even a proper homebrew fork in our organization. THIS WILL NOT WORK out of the box. Refer to PR #1008 to get instruction on additional steps needed to make this run. [note] Remove cask generation from normal release workflow. Later on the release workflow has to trigger the cask workflow. Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2022-11-30 00:00:18 +01:00
* `fetch-archives.sh`: Script to download the release zip archives [6]
Add documentation to bin/scripts/ directory Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2022-09-16 11:15:26 +02:00
* `fpfix.py`: Can be used to set isFixedPitch property in a font [x]
CI: Add new workflow to create all casks [skip-ci] Now we can create the casks of some specific release ('latest' in this case) at will, based purely on the artifact files and on nothing in the repo. We do not even need to fetch the repo. This is still some kind of WIP, because we do not have the secrets and not even a proper homebrew fork in our organization. THIS WILL NOT WORK out of the box. Refer to PR #1008 to get instruction on additional steps needed to make this run. [note] Remove cask generation from normal release workflow. Later on the release workflow has to trigger the cask workflow. Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2022-11-30 00:00:18 +01:00
* `generate-casks.sh`: Generates cask files for fonts from data in `archives/` [6]
doc: Better document how the Cheat Sheet is generated [skip ci] Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2023-01-13 12:06:27 +01:00
* `generate-css.sh`: Generates the Nerd Fonts CCS, which can be used to access the glyphs on a web page, and the Cheat Sheet [1]
font-patcher: Patch in heavy angle brackets [why] The heavy angle brackets (276E and 276F) are used for a lot of prompts, but we do not yet patch them in and a lot of fonts do not bring them themselves. [how] One time rip the glyphs out from Hack and patch them in always, but careful (do not replace existing glyph). We take the whole set 276C - 2771. [note] Usually we should never again need to run the generate-extraglyphs script, we rip them out now and they look good. Whatever Hack does with new versions we can follow but that is optional. Related: #1110 Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2023-02-10 16:24:54 +01:00
* `generate-extraglyphs.py:` Generates `extraglyphs.sfd` from Hack Regular [4]
Add documentation to bin/scripts/ directory Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2022-09-16 11:15:26 +02:00
* `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]
Update documentation
2022-09-19 18:11:48 +02:00
* `generate-original-source.py`: Generate `original-source.otf` from single glyph svgs. [5]
Add small tool to create release artefact table Usage is a bit ... hard, because we need to do this before the release is published. Download the complete artifact zip archive from the release-drafting run. Unpack it into the repository (will end up in patched-fonts/) Pack all archives with archive-fonts.sh Then use this tool to extract the names and sizes of the artifacts. Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2023-11-21 14:18:26 +01:00
* `generate-release-summary.sh`: Helper to generate the release table with zip and xz [3]
Add script to create sample set [why] After changing something in the patch process it is unclear if all the prepatched fonts will look ok later. It would be nice to produce one font from each input font (and not the complete set of each of the faces of that font) to have some hopefully representative example how symbols will blend into the font. [how] Add a script with explicit list of representative fonts. Evaluate the config.cfg and execute one patcher run. Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2023-05-12 08:49:36 +02:00
* `generate-sample-set.sh`: Generate one patched font file from each source font (for manual checks) [4]
CI: Automatically deploy webfonts [skip ci] [why] The webfonts are needed for the cheat sheet. When we update the sheet code we probably need also new fonts. The fonts might contain fixes also if there is no need for a new sheet, so they have to be updated on every release. [how] Add mini-script that generates the woff's from the latest 'ttf'. This makes it easier to check the woffs manually. Let the workflow create the woffs, and push them to the gh-pages. Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2022-12-16 17:01:54 +01:00
* `generate-webfonts.sh`: Generate woff and woff2 font files from the SymbolsOnly font (for the gh-pages) [1]
Add documentation to bin/scripts/ directory Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2022-09-16 11:15:26 +02:00
* `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)
Update documentation
2022-09-19 18:11:48 +02:00
* `optimize-original-source.sh`: Run all icons in `src/svgs` through inkscape to simplify (remove nodes and edges) [5]
Add documentation to bin/scripts/ directory Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2022-09-16 11:15:26 +02:00
* `release.sh`: Rough process how a release is created, not used (see `.github/workflows/release.yml`)
Drop counting variations stuff and unify readme creation [why] The variation lists are very long and noone will ever look at them. Instead we have a font-info.md file, for what reasons? [how] Replace the function the font-info.md file had with README.md. Drop all the variation lists. Automatically call the readme creation in the gotta-patch-em instead of just hinting that one should call that (standardize-and-complete-readmes.sh).
2023-04-25 17:56:56 +02:00
* `standardize-and-complete-readmes.sh`: Used by `gotta-patch-em-all-font-patcher!.sh`
Add documentation to bin/scripts/ directory Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2022-09-16 11:15:26 +02:00
* `test-fonts.sh`: Print-to-debug all glyphs we patch in [4]
* `test-powerlines.sh`: Print-to-debug powerline examples [4]
Add another test for Powerline glyphs A more conceise version of the Powerline test, designed to show the dreaded 'faint vertical lines' phenomenon from LCD antialiasing Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2024-03-29 13:16:02 +01:00
* `test-vertical-lines.sh`: Print-to-debug powerline examples [4]
CI: Create CI for contributors update [why] It's a pain to have the addition of contributors automated via all-contributors bot, but then it does not end up on the webpage. [how] I'm not sure it will automatically be triggered (pretty sure it will not), but at least one can clickstart manually the workflow. Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2023-01-27 15:34:25 +01:00
* `update-all-contributors-website.py`: Update the contributors page on `nerdfonts.com` (i.e. gh-pages) [7]
Sunset in-repo releases [why] We struggle with the pack-committing of patched fonts to the repository on release. This makes our repo grow extremely big. It would be better to just use release artifacts for the releases and not commit any patched font back. There were different approaches discussed, but the problem remains that I personally have no rights to implement anything of that - neither can I force push to the default branch, nor can I create new repos in the organization. [how] To make it still possible to add new fonts without a repo size explosion we do not release NEW fonts back to the repository as commits, but old fonts are handled as before. NEW fonts: * have a new property set in the fonts.yaml 'database' * are released as release artifact via release workflow (but not committed back) * get a readme in the patched_fonts/ directory that points to the release artifact page The solution is not ideal, but for sure better than not adding any fonts anymore or having the repo grow in size faster and faster. At some point in time I would like to phase out all in-repo releases, also for OLD fonts. This scheme has been (manually) used / introduced for Intel One. With this change the .gitignore file is automatically adapted to any new font that is added with the repoRelease flag set to false (which should be the default for any added font from now on). Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2023-09-27 10:48:32 +02:00
* `update-gitignore.sh`: Correct gitignore file for not-released-in-repo fonts [8]
Add documentation to bin/scripts/ directory Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2022-09-16 11:15:26 +02:00
* `version-bump.sh`: Change version number in all scripts on a new release [1]
[1] Used by CI (github release workflow)
[2] Used by CI (github docker-release workflow)
[3] To be used manually (sigh)
[4] To be used manually
Update documentation
2022-09-19 18:11:48 +02:00
[5] Used by CI (github packsvgs workflow)
CI: Add new workflow to create all casks [skip-ci] Now we can create the casks of some specific release ('latest' in this case) at will, based purely on the artifact files and on nothing in the repo. We do not even need to fetch the repo. This is still some kind of WIP, because we do not have the secrets and not even a proper homebrew fork in our organization. THIS WILL NOT WORK out of the box. Refer to PR #1008 to get instruction on additional steps needed to make this run. [note] Remove cask generation from normal release workflow. Later on the release workflow has to trigger the cask workflow. Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2022-11-30 00:00:18 +01:00
[6] Used by CI (github casks workflow)
CI: Create CI for contributors update [why] It's a pain to have the addition of contributors automated via all-contributors bot, but then it does not end up on the webpage. [how] I'm not sure it will automatically be triggered (pretty sure it will not), but at least one can clickstart manually the workflow. Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2023-01-27 15:34:25 +01:00
[7] Used by CI (github contributors workflow)
Sunset in-repo releases [why] We struggle with the pack-committing of patched fonts to the repository on release. This makes our repo grow extremely big. It would be better to just use release artifacts for the releases and not commit any patched font back. There were different approaches discussed, but the problem remains that I personally have no rights to implement anything of that - neither can I force push to the default branch, nor can I create new repos in the organization. [how] To make it still possible to add new fonts without a repo size explosion we do not release NEW fonts back to the repository as commits, but old fonts are handled as before. NEW fonts: * have a new property set in the fonts.yaml 'database' * are released as release artifact via release workflow (but not committed back) * get a readme in the patched_fonts/ directory that points to the release artifact page The solution is not ideal, but for sure better than not adding any fonts anymore or having the repo grow in size faster and faster. At some point in time I would like to phase out all in-repo releases, also for OLD fonts. This scheme has been (manually) used / introduced for Intel One. With this change the .gitignore file is automatically adapted to any new font that is added with the repoRelease flag set to false (which should be the default for any added font from now on). Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>
2023-09-27 10:48:32 +02:00
[8] Used by CI (github fontjson workflow)
Reference in a new issue Copy permalink