casks: Finalizing touches

Add some more documentation / comments.
Increase version number.

Signed-off-by: Fini Jastrow <ulf.fini.jastrow@desy.de>

bin/scripts/README.md

@@ -8,7 +8,7 @@ Note: Usually you need to call the scripts in this directory while actually bein
 * `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]
 * `fpfix.py`: Can be used to set isFixedPitch property in a font [x]
-* `generate-casks.sh`: Generates cask files for fonts from data in `patched-fonts/` and `archives/`, unused and not recommended by homebrew-fonts
+* `generate-casks.sh`: Generates cask files for fonts from data in `patched-fonts/` and `archives/` [3]
 * `generate-css.sh`: Generates the Nerd Fonts CCS, which can be used to access the glyphs on a web page [1]
 * `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]

bin/scripts/generate-casks.sh

@@ -1,9 +1,13 @@
 #!/usr/bin/env bash
 # Nerd Fonts Version: 2.3.0-RC
-# Script Version: 1.0.1
-# Iterates over all patched fonts directories
+# Script Version: 2.0.0
+# Iterates over all [*] patched fonts directories
 # to generate ruby cask files for homebrew-fonts (https://github.com/caskroom/homebrew-fonts)
-# only adds non-Windows versions of the fonts
+# * Only adds non-Windows versions of the fonts
+# * Needs the zip archives in archives/ (i.e. run `./archive-fonts.sh` first)
+#
+# [1] Accepts one parameter, a pattern which fonts to examine, if not given defaults
+# to "*" which is all fonts. Example `./generate-casks.sh 'Hasklig'`
 
 #set -x
 set -e