From 224174a663398b00647fafab2cf6267bb45323d0 Mon Sep 17 00:00:00 2001 From: Fini Jastrow Date: Fri, 30 Aug 2024 12:46:39 +0200 Subject: [PATCH] doc: Show RFN permissions more visibly [why] The fonts where we are allowed to keep the font name despite the RFN clause in the license have nothing mentioning of RFN or the exception in the readmes. But it is recommended (required?) by SIL to inform users of that exception in a most transparent way. [how] Add that bit of information to the readme files in the patched-fonts directories and the release archives. [note] Also some other information seemed to be missing, by the complete rebuild of the readme it also got updated (Gohu/ProFont). Signed-off-by: Fini Jastrow --- bin/scripts/lib/fonts.json | 2 ++ .../standardize-and-complete-readmes.sh | 30 +++++++++++++------ patched-fonts/EnvyCodeR/README.md | 14 +++++++++ patched-fonts/Gohu/11/README.md | 9 +++--- patched-fonts/Gohu/14/README.md | 9 +++--- patched-fonts/Gohu/README.md | 9 +++--- patched-fonts/Gohu/uni-11/README.md | 9 +++--- patched-fonts/Gohu/uni-14/README.md | 9 +++--- patched-fonts/Mononoki/Bold-Italic/README.md | 14 +++++++++ patched-fonts/Mononoki/Bold/README.md | 14 +++++++++ patched-fonts/Mononoki/Italic/README.md | 14 +++++++++ patched-fonts/Mononoki/README.md | 14 +++++++++ patched-fonts/Mononoki/Regular/README.md | 14 +++++++++ .../ProFont/ProFontWinTweaked/LICENSE | 2 +- patched-fonts/ProFont/profontiix/LICENSE | 2 +- src/readme-rfn-addendum.md | 3 -- 16 files changed, 129 insertions(+), 39 deletions(-) diff --git a/bin/scripts/lib/fonts.json b/bin/scripts/lib/fonts.json index 799f19928..accc3adcd 100644 --- a/bin/scripts/lib/fonts.json +++ b/bin/scripts/lib/fonts.json @@ -270,6 +270,7 @@ "unpatchedName": "Envy Code R", "licenseId": "OFL-1.1-RFN", "RFN": true, + "RFNException": "https://github.com/ryanoasis/nerd-fonts/pull/1318#issuecomment-1636737323", "version": "0.79", "patchedName": "EnvyCodeR", "folderName": "EnvyCodeR", @@ -662,6 +663,7 @@ "unpatchedName": "Mononoki", "licenseId": "OFL-1.1-RFN", "RFN": true, + "RFNException": "https://github.com/ryanoasis/nerd-fonts/issues/575#issuecomment-1385308049", "version": "1.6", "patchedName": "Mononoki", "folderName": "Mononoki", diff --git a/bin/scripts/standardize-and-complete-readmes.sh b/bin/scripts/standardize-and-complete-readmes.sh index 0959e6d0c..e9dd61f3a 100755 --- a/bin/scripts/standardize-and-complete-readmes.sh +++ b/bin/scripts/standardize-and-complete-readmes.sh @@ -34,15 +34,23 @@ function appendGeneralInfo { function appendRfnInfo { local config_rfn=$1; shift local config_rfn_substitue=$1; shift + local config_rfn_exception=$1; shift local working_dir=$1; shift local to=$1; shift - if [ "$config_rfn" ] && [ "$config_rfn_substitue" ] - then - # add to the file - { - printf "\\n## Why \`%s\` and not \`%s\`?\\n" "$config_rfn_substitue" "$config_rfn" - cat "$working_dir/../../src/readme-rfn-addendum.md" - } >> "$to" + if [ "$config_rfn" ]; then + if [ "$config_rfn_substitue" ]; then + { + printf "\\n## Why \`%s\` and not \`%s\`?\\n" "$config_rfn_substitue" "$config_rfn" + printf "\\nWhat's in a name? The reason for the name change is to comply with the SIL Open Font License (OFL), in particular the [Reserved Font Name mechanism][SIL-RFN]\\n\\n" + cat "$working_dir/../../src/readme-rfn-addendum.md" + } >> "$to" + else + printf "\\n## \`%s\` is a Reserved Font Name\\n\\n" "$config_rfn" >> "$to" + cat "$working_dir/../../src/readme-rfn-addendum.md" >> "$to" + if [ -n "${config_rfn_exception}" ]; then + printf "\\nFind Nerd Font's permission to keep the name here: %s\\n" "$config_rfn_exception" >> "$to" + fi + fi fi } @@ -89,6 +97,7 @@ do # reset the variables unset config_rfn unset config_rfn_substitue + unset config_rfn_exception fontdata=$(jq ".fonts[] | select(.folderName == \"${base_directory}\")" "${fonts_info}") if [ "$(echo "$fontdata" | jq .RFN)" = "true" ] then @@ -96,12 +105,15 @@ do config_rfn_substitue=$(echo "$fontdata" | jq -r .patchedName) check_config_rfn=$(tr '[:upper:]' '[:lower:]' <<< "$config_rfn" | tr -d ' ') check_config_rfn_sub=$(tr '[:upper:]' '[:lower:]' <<< "$config_rfn_substitue" | tr -d ' ') + config_rfn_exception=$(echo "$fontdata" | jq -r .RFNException) if [ "${check_config_rfn}" = "${check_config_rfn_sub}" ] then # Only the case with Mononoki and Envy Code R which is RFN but we do not rename (we got the permission to keep the name) - unset config_rfn unset config_rfn_substitue fi + if [ "${config_rfn_exception}" = "null" ]; then + unset config_rfn_exception + fi fi unset release_to_repo # This defaults to true if no info is given: @@ -157,7 +169,7 @@ do printf "# %s\\n\\n" "$base_directory" } >> "$to" fi - appendRfnInfo "$config_rfn" "$config_rfn_substitue" "$sd" "$to" + appendRfnInfo "$config_rfn" "$config_rfn_substitue" "$config_rfn_exception" "$sd" "$to" appendGeneralInfo "$to" "$base_directory" "$release_to_repo" done diff --git a/patched-fonts/EnvyCodeR/README.md b/patched-fonts/EnvyCodeR/README.md index a56cbc406..1556cb69d 100644 --- a/patched-fonts/EnvyCodeR/README.md +++ b/patched-fonts/EnvyCodeR/README.md @@ -7,6 +7,20 @@ or http://damieng.com/fonts/envy-code-r. Version: 0.79 +## `Envy Code R` is a Reserved Font Name + +Some fonts have parts of their name "reserved" per the [Reserved Font Name mechanism][SIL-RFN]: +> No Modified Version of the Font Software may use the Reserved Font +> Name(s) unless explicit written permission is granted by the corresponding +> Copyright Holder. This restriction only applies to the primary font name as +> presented to the users. + +- The main goals seem to be to: `Avoid collisions`, `Protect authors`, `Minimize support`, and `Encourage derivatives` + +See the [Reserved Font Name section][SIL-RFN] for additional information + +Find Nerd Font's permission to keep the name here: https://github.com/ryanoasis/nerd-fonts/pull/1318#issuecomment-1636737323 + ## Which font? ### TL;DR diff --git a/patched-fonts/Gohu/11/README.md b/patched-fonts/Gohu/11/README.md index bb6564307..6082bdb8b 100644 --- a/patched-fonts/Gohu/11/README.md +++ b/patched-fonts/Gohu/11/README.md @@ -6,13 +6,12 @@ TrueType automatically traced, with available bitmaps in heights of 11 and 14 pi Copyright 2010 by Hugo Chargois (http://font.gohu.eu) Converted by Guilherme Maeda (github.com/koemaeda) -**Thanks and aknowledgments** - -The Unicode versions of the 11px font are based extensively on the fixed 6x10 font by Markus Kuhn (http://www.cl.cam.ac.uk/~mgk25/ucs-fonts.html). -I used the Terminus font in 14 px with great satisfaction for a long time before I decided to make gohufont 14 px, so it surely inspired me and they may share some similarities in appearance. It is not a derivative work though. Thanks to Dimitar Zhekov for his great font. - For more information have a look at the upstream websites: http://font.gohu.org/ https://github.com/koemaeda/gohufont-ttf +## Preprocessed Source Font + +Nerd Fonts corrects the wrong question mark in gohufont-14. + Version: 1.33 ## Which font? diff --git a/patched-fonts/Gohu/14/README.md b/patched-fonts/Gohu/14/README.md index bb6564307..6082bdb8b 100644 --- a/patched-fonts/Gohu/14/README.md +++ b/patched-fonts/Gohu/14/README.md @@ -6,13 +6,12 @@ TrueType automatically traced, with available bitmaps in heights of 11 and 14 pi Copyright 2010 by Hugo Chargois (http://font.gohu.eu) Converted by Guilherme Maeda (github.com/koemaeda) -**Thanks and aknowledgments** - -The Unicode versions of the 11px font are based extensively on the fixed 6x10 font by Markus Kuhn (http://www.cl.cam.ac.uk/~mgk25/ucs-fonts.html). -I used the Terminus font in 14 px with great satisfaction for a long time before I decided to make gohufont 14 px, so it surely inspired me and they may share some similarities in appearance. It is not a derivative work though. Thanks to Dimitar Zhekov for his great font. - For more information have a look at the upstream websites: http://font.gohu.org/ https://github.com/koemaeda/gohufont-ttf +## Preprocessed Source Font + +Nerd Fonts corrects the wrong question mark in gohufont-14. + Version: 1.33 ## Which font? diff --git a/patched-fonts/Gohu/README.md b/patched-fonts/Gohu/README.md index bb6564307..6082bdb8b 100644 --- a/patched-fonts/Gohu/README.md +++ b/patched-fonts/Gohu/README.md @@ -6,13 +6,12 @@ TrueType automatically traced, with available bitmaps in heights of 11 and 14 pi Copyright 2010 by Hugo Chargois (http://font.gohu.eu) Converted by Guilherme Maeda (github.com/koemaeda) -**Thanks and aknowledgments** - -The Unicode versions of the 11px font are based extensively on the fixed 6x10 font by Markus Kuhn (http://www.cl.cam.ac.uk/~mgk25/ucs-fonts.html). -I used the Terminus font in 14 px with great satisfaction for a long time before I decided to make gohufont 14 px, so it surely inspired me and they may share some similarities in appearance. It is not a derivative work though. Thanks to Dimitar Zhekov for his great font. - For more information have a look at the upstream websites: http://font.gohu.org/ https://github.com/koemaeda/gohufont-ttf +## Preprocessed Source Font + +Nerd Fonts corrects the wrong question mark in gohufont-14. + Version: 1.33 ## Which font? diff --git a/patched-fonts/Gohu/uni-11/README.md b/patched-fonts/Gohu/uni-11/README.md index bb6564307..6082bdb8b 100644 --- a/patched-fonts/Gohu/uni-11/README.md +++ b/patched-fonts/Gohu/uni-11/README.md @@ -6,13 +6,12 @@ TrueType automatically traced, with available bitmaps in heights of 11 and 14 pi Copyright 2010 by Hugo Chargois (http://font.gohu.eu) Converted by Guilherme Maeda (github.com/koemaeda) -**Thanks and aknowledgments** - -The Unicode versions of the 11px font are based extensively on the fixed 6x10 font by Markus Kuhn (http://www.cl.cam.ac.uk/~mgk25/ucs-fonts.html). -I used the Terminus font in 14 px with great satisfaction for a long time before I decided to make gohufont 14 px, so it surely inspired me and they may share some similarities in appearance. It is not a derivative work though. Thanks to Dimitar Zhekov for his great font. - For more information have a look at the upstream websites: http://font.gohu.org/ https://github.com/koemaeda/gohufont-ttf +## Preprocessed Source Font + +Nerd Fonts corrects the wrong question mark in gohufont-14. + Version: 1.33 ## Which font? diff --git a/patched-fonts/Gohu/uni-14/README.md b/patched-fonts/Gohu/uni-14/README.md index bb6564307..6082bdb8b 100644 --- a/patched-fonts/Gohu/uni-14/README.md +++ b/patched-fonts/Gohu/uni-14/README.md @@ -6,13 +6,12 @@ TrueType automatically traced, with available bitmaps in heights of 11 and 14 pi Copyright 2010 by Hugo Chargois (http://font.gohu.eu) Converted by Guilherme Maeda (github.com/koemaeda) -**Thanks and aknowledgments** - -The Unicode versions of the 11px font are based extensively on the fixed 6x10 font by Markus Kuhn (http://www.cl.cam.ac.uk/~mgk25/ucs-fonts.html). -I used the Terminus font in 14 px with great satisfaction for a long time before I decided to make gohufont 14 px, so it surely inspired me and they may share some similarities in appearance. It is not a derivative work though. Thanks to Dimitar Zhekov for his great font. - For more information have a look at the upstream websites: http://font.gohu.org/ https://github.com/koemaeda/gohufont-ttf +## Preprocessed Source Font + +Nerd Fonts corrects the wrong question mark in gohufont-14. + Version: 1.33 ## Which font? diff --git a/patched-fonts/Mononoki/Bold-Italic/README.md b/patched-fonts/Mononoki/Bold-Italic/README.md index e7721b98a..88073e0e8 100644 --- a/patched-fonts/Mononoki/Bold-Italic/README.md +++ b/patched-fonts/Mononoki/Bold-Italic/README.md @@ -6,6 +6,20 @@ For more information have a look at the upstream website: https://github.com/mad Version: 1.6 +## `Mononoki` is a Reserved Font Name + +Some fonts have parts of their name "reserved" per the [Reserved Font Name mechanism][SIL-RFN]: +> No Modified Version of the Font Software may use the Reserved Font +> Name(s) unless explicit written permission is granted by the corresponding +> Copyright Holder. This restriction only applies to the primary font name as +> presented to the users. + +- The main goals seem to be to: `Avoid collisions`, `Protect authors`, `Minimize support`, and `Encourage derivatives` + +See the [Reserved Font Name section][SIL-RFN] for additional information + +Find Nerd Font's permission to keep the name here: https://github.com/ryanoasis/nerd-fonts/issues/575#issuecomment-1385308049 + ## Which font? ### TL;DR diff --git a/patched-fonts/Mononoki/Bold/README.md b/patched-fonts/Mononoki/Bold/README.md index e7721b98a..88073e0e8 100644 --- a/patched-fonts/Mononoki/Bold/README.md +++ b/patched-fonts/Mononoki/Bold/README.md @@ -6,6 +6,20 @@ For more information have a look at the upstream website: https://github.com/mad Version: 1.6 +## `Mononoki` is a Reserved Font Name + +Some fonts have parts of their name "reserved" per the [Reserved Font Name mechanism][SIL-RFN]: +> No Modified Version of the Font Software may use the Reserved Font +> Name(s) unless explicit written permission is granted by the corresponding +> Copyright Holder. This restriction only applies to the primary font name as +> presented to the users. + +- The main goals seem to be to: `Avoid collisions`, `Protect authors`, `Minimize support`, and `Encourage derivatives` + +See the [Reserved Font Name section][SIL-RFN] for additional information + +Find Nerd Font's permission to keep the name here: https://github.com/ryanoasis/nerd-fonts/issues/575#issuecomment-1385308049 + ## Which font? ### TL;DR diff --git a/patched-fonts/Mononoki/Italic/README.md b/patched-fonts/Mononoki/Italic/README.md index e7721b98a..88073e0e8 100644 --- a/patched-fonts/Mononoki/Italic/README.md +++ b/patched-fonts/Mononoki/Italic/README.md @@ -6,6 +6,20 @@ For more information have a look at the upstream website: https://github.com/mad Version: 1.6 +## `Mononoki` is a Reserved Font Name + +Some fonts have parts of their name "reserved" per the [Reserved Font Name mechanism][SIL-RFN]: +> No Modified Version of the Font Software may use the Reserved Font +> Name(s) unless explicit written permission is granted by the corresponding +> Copyright Holder. This restriction only applies to the primary font name as +> presented to the users. + +- The main goals seem to be to: `Avoid collisions`, `Protect authors`, `Minimize support`, and `Encourage derivatives` + +See the [Reserved Font Name section][SIL-RFN] for additional information + +Find Nerd Font's permission to keep the name here: https://github.com/ryanoasis/nerd-fonts/issues/575#issuecomment-1385308049 + ## Which font? ### TL;DR diff --git a/patched-fonts/Mononoki/README.md b/patched-fonts/Mononoki/README.md index e7721b98a..88073e0e8 100644 --- a/patched-fonts/Mononoki/README.md +++ b/patched-fonts/Mononoki/README.md @@ -6,6 +6,20 @@ For more information have a look at the upstream website: https://github.com/mad Version: 1.6 +## `Mononoki` is a Reserved Font Name + +Some fonts have parts of their name "reserved" per the [Reserved Font Name mechanism][SIL-RFN]: +> No Modified Version of the Font Software may use the Reserved Font +> Name(s) unless explicit written permission is granted by the corresponding +> Copyright Holder. This restriction only applies to the primary font name as +> presented to the users. + +- The main goals seem to be to: `Avoid collisions`, `Protect authors`, `Minimize support`, and `Encourage derivatives` + +See the [Reserved Font Name section][SIL-RFN] for additional information + +Find Nerd Font's permission to keep the name here: https://github.com/ryanoasis/nerd-fonts/issues/575#issuecomment-1385308049 + ## Which font? ### TL;DR diff --git a/patched-fonts/Mononoki/Regular/README.md b/patched-fonts/Mononoki/Regular/README.md index e7721b98a..88073e0e8 100644 --- a/patched-fonts/Mononoki/Regular/README.md +++ b/patched-fonts/Mononoki/Regular/README.md @@ -6,6 +6,20 @@ For more information have a look at the upstream website: https://github.com/mad Version: 1.6 +## `Mononoki` is a Reserved Font Name + +Some fonts have parts of their name "reserved" per the [Reserved Font Name mechanism][SIL-RFN]: +> No Modified Version of the Font Software may use the Reserved Font +> Name(s) unless explicit written permission is granted by the corresponding +> Copyright Holder. This restriction only applies to the primary font name as +> presented to the users. + +- The main goals seem to be to: `Avoid collisions`, `Protect authors`, `Minimize support`, and `Encourage derivatives` + +See the [Reserved Font Name section][SIL-RFN] for additional information + +Find Nerd Font's permission to keep the name here: https://github.com/ryanoasis/nerd-fonts/issues/575#issuecomment-1385308049 + ## Which font? ### TL;DR diff --git a/patched-fonts/ProFont/ProFontWinTweaked/LICENSE b/patched-fonts/ProFont/ProFontWinTweaked/LICENSE index dcc3f128a..2fa45cd8a 100644 --- a/patched-fonts/ProFont/ProFontWinTweaked/LICENSE +++ b/patched-fonts/ProFont/ProFontWinTweaked/LICENSE @@ -1,7 +1,7 @@ ProFont MIT License -Copyright (c) 2014 Carl Osterwald, Stephen C. Gilardi, Andrew Welch +Copyright (c) 2014 Tobias Jung, Carl Osterwald, Stephen C. Gilardi, Andrew Welch Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/patched-fonts/ProFont/profontiix/LICENSE b/patched-fonts/ProFont/profontiix/LICENSE index dcc3f128a..2fa45cd8a 100644 --- a/patched-fonts/ProFont/profontiix/LICENSE +++ b/patched-fonts/ProFont/profontiix/LICENSE @@ -1,7 +1,7 @@ ProFont MIT License -Copyright (c) 2014 Carl Osterwald, Stephen C. Gilardi, Andrew Welch +Copyright (c) 2014 Tobias Jung, Carl Osterwald, Stephen C. Gilardi, Andrew Welch Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/src/readme-rfn-addendum.md b/src/readme-rfn-addendum.md index e0bd20d5c..91ff45bde 100644 --- a/src/readme-rfn-addendum.md +++ b/src/readme-rfn-addendum.md @@ -1,6 +1,3 @@ - -What's in a name? The reason for the name change is to comply with the SIL Open Font License (OFL), in particular the [Reserved Font Name mechanism][SIL-RFN] - Some fonts have parts of their name "reserved" per the [Reserved Font Name mechanism][SIL-RFN]: > No Modified Version of the Font Software may use the Reserved Font > Name(s) unless explicit written permission is granted by the corresponding