Update documentation

.gitlab-ci.yml

@@ -49,8 +49,8 @@ release:
     - job: build
       artifacts: true
   release:
-    name: 'Release $CI_COMMIT_SHORT_SHA of $CI_PROJECT_NAME'
-    description: 'Created using the release-cli' # Need to replace with 'CHANGELOG.md'
+    name: 'Release $CI_COMMIT_TAG of $CI_PROJECT_NAME'
+    description: 'Rlease $CI_COMMIT_TAG' # Need to replace with 'CHANGELOG.md'
     # tag_name is a mandatory field and can not be an empty string
     tag_name: '$CI_COMMIT_TAG'
     ref: $CI_COMMIT_TAG

CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# Contributing to the Nupuram Project
+
+## Types of contributions
+
+**Issues**
+
+If you find something that’s not working as you expect, please file an issue
+
+**Documentation improvements**
+
+If you find a typo or something that seems out of date in the Readme, etc, please feel free to file a Pull Request with your suggested change(s)
+
+**Type design fixes/changes**
+
+Type design is a bit of a special case for open source projects, because type tends to benefit from a central, strong creative & technical direction. There are probably exceptions to this, but Recursive is not really one of them.
+
+That said, type design contributions are very highly valued here, but they require a connection and personal communication to go well.
+
+Have an idea for something that you think would be worth changing in the design? Cool! You have two good options:
+
+1. File an issue to point out the design problem, and mention your idea/request to fix it, if you have one. We will try to comment on the issue fairly promptly, and the proposed solution can be discussed before a course of action is decided.
+2. Alternatively, this project is [OFL-licensed](OFL.txt), so you are welcome to fork the repo and make whatever changes you like, so long as you keep the same license and respect its provisions. In this scenario, please be sure to change the font family name to avoid user confusion.
+

FAQ.md

@@ -0,0 +1,13 @@
+## Can I help with improving Nupuram?
+
+Yes you can! Nupuram is an open-source project, meaning the source code—or "source design" if you will—that is used to build the font files are freely available to improve upon. Font making requires a fair bit of technical work and depending on what you'd like to do, some things might be more fun depending on your technical skills. Please start by reading and exploring the source code and design files provided.
+
+Also see [CONTRIBUTING.md](CONTRIBUTING.md)
+
+## I like to modify some of the glyphs or opentype rules and redistribute the font. What are the recommendations to do that?
+
+Nupuram is licensed as Open Font License, which gives you the freedom to modify the font for your need and redistribute it as per the license. However a few points should be noted:
+
+* If the modified and redistributed font has the same name of original font, it will overwrite existing font in operating systems. A user won't be able to use the original Nupuram font. If editable documents are opened and saved in same operating system, they will be re-rendered in the modified version, which the user might not want. So avoid this disruption by renaming the modified version of the font.
+* The glyphs, its design, its engineering, its opentype rules are the identity of the font. If you are renaming the font, please choose a completely different name that has no relation with Nupuram. For example, Nupuram New, Nupuram Modern etc would give a misunderstanding that the designer of Nupuram released new version of Nupuram and would attribute the new font with the designer. This is undesirable to the designer since the modified font cannot be supported by the designer. Please spare the designer of the original font from responding to support requests that actually stem from bugs in a modified version.
+* See section 3 and 4 of OFL license under "PERMISSION & CONDITIONS"

README.md

@@ -95,14 +95,80 @@ In general, you should link in the font with @font-face
  font-style: oblique 0deg -15deg;
 }
 ```
+
 Then, you can use the font with both `font-weight` and `font-variation-settings`. Using CSS [custom properties will help](https://pixelambacht.nl/2019/fixing-variable-font-inheritance/) to avoid some caveats of property inheritance.
 
+### Using Color fonts in web
+
+Since chrome based browsers support COLRv1 spec which allows customization of pallettes and color gradients and all other browser does not support it, we need to use some feature support testing in CSS.
+
+```css
+/* Firefox and old browsers - use ColrV0 */
+@supports not (font-palette: --custom) {
+  @font-face {
+    font-family: "NupuramShadowColor";
+    src: url(../fonts/webfonts/Nupuram-Color-v0.woff2) format("woff2");
+  }
+}
+/*Chromium based browsers - Use colrv1 */
+@supports (font-palette: --custom) {
+  @font-face {
+    font-family: "NupuramShadowColor";
+    src: url(../path/to/Nupuram-Color-v1.woff2) format("woff2");
+  }
+}
+```
+
+## Building the fonts
+
+Install the required software packages, assuming a debian based GNU/Linux Operating system
+
+```bash
+apt-get update -y
+apt-get install -y make python3-pip python3-venv python3-yaml texlive-metapost libharfbuzz-bin
+```
+
+To build, set up the virtual environment and activate it.
+
+```bash
+virtualenv -p python3 venv
+source venv/bin/activate
+```
+
+Then install requirements:
+
+```bash
+pip install -U -r requirements.txt
+```
+
+Then run make to build everything
+
+```bash
+make
+```
+
+This will take more than 15 minutes to build everything. But if you have a multi core processor, you can speed up this by using parallel build. Assuming you have 8 core system(8 CPUs)
+
+```
+make -j8
+```
+
+A directory name d riable fonts, UFO sources generated there.
+
 ## Language support
 
 Nupuram is primarily a Malayalam font. All the Malayalam characters defined in Unicode version 15 are present in the font. Nupuram also has latin script support. So Nupuram supports 39 languages:
 
 Afrikaans, Albanian, Basque, Bosnian, Catalan, Croatian, Czech, Danish, Dutch, English, Estonian, Faroese, Filipino, Finnish, French, Galician, German, Hungarian, Icelandic, Indonesian, Irish, Italian, Latvian, Lithuanian, Malay, Malayalam, Norwegian Bokmål, Polish, Portuguese, Romanian, Slovak, Slovenian, Spanish, Swahili, Swedish, Tongan, Turkish, Welsh and Zulu.
 
+## Credits
+
+See [FONTLOG.md](FONTLOG.md) for details on contributions.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for policies around contributing to the project.
+
 ## License
 
 This Font Software is licensed under the SIL Open Font License, Version 1.1. This license is available with a FAQ at: https://scripts.sil.org/OFL

tests/index.html

@@ -25,7 +25,7 @@ <h5 id="font-version"></h5>
 							<option value="Nupuram">Nupuram</option>
 							<option value="NupuramCalligraphy">Nupuram Calligraphy</option>
 							<option value="NupuramDisplay">Nupuram Display</option>
-							<option value="NupuramShadowColor">Nupuram Shadow Color</option>
+							<option value="NupuramColor">Nupuram Color</option>
 							<option value="NupuramArrowsColor">Nupuram Arrow Color</option>
 							<option value="NupuramDots">Nupuram Dots</option>
 						</select>
@@ -37,8 +37,8 @@ <h5 id="font-version"></h5>
 						<input type="number" value="0" min="0" max="18" class="font-color-palette" data-id="fontColorPalette" id="font-fontColorPalette"></label>
 					</div>
 					<div class="primitive-input">
-						<label for="font-fontShadowColor">Dark
-						<input type="button" class="font-color " data-id="fontShadowColor" id="font-fontShadowColor"></label>
+						<label for="font-fontColor">Dark
+						<input type="button" class="font-color " data-id="fontColor" id="font-fontColor"></label>
 					</div>
 					<div class="primitive-input">
 						<label for="font-fontBaseColor">Light

tests/main.js

@@ -141,11 +141,11 @@ function listen() {
     document.getElementById('test-font').addEventListener('change', function () {
         const selected = this.options[this.selectedIndex].value;
         contentArea.classList.add('shadownorth');
-        contentArea.classList.remove("shadowcolor", "display", "arrowscolor", "calligraphy","dots");
+        contentArea.classList.remove("color", "display", "arrowscolor", "calligraphy","dots");
         document.getElementById('palette').style.display = "none"
         document.getElementById('font-fontColor').disabled = false
         root.style.setProperty('--font', selected);
-        if (selected === 'NupuramShadowColor') {
+        if (selected === 'NupuramColor') {
             document.getElementById('font-fontColor').disabled = true
             document.getElementById('palette').style.display = "grid"
         }

tests/styles.css

@@ -1,8 +1,11 @@
 @font-face {
   font-family: "Nupuram";
-  src: url(../fonts/webfonts/Nupuram-VF.woff2?v=1.100) format("woff2"),
-    url(../fonts/otf/Nupuram-VF.otf?v=1.100) format("opentype"),
+  src: url(../fonts/webfonts/Nupuram-VF.woff2?v=1.100) format("woff2-variations"),
+    url(../fonts/otf/Nupuram-VF.otf?v=1.100) format("opentype-variations"),
     url(../fonts/otf/Nupuram-Regular.otf) format("opentype");
+  font-weight: 100 900;
+  font-stretch: 75% 125%;
+  font-style: oblique 0deg -15deg;
 }
 
 @font-face {
@@ -15,8 +18,8 @@
 @supports not (font-palette: --custom) {
   @font-face {
     font-family: "NupuramShadowColor";
-    src: url(../fonts/webfonts/Nupuram-Shadow-Color-v0.woff2?v=1.100) format("woff2"),
-        url(../fonts/otf/Nupuram-Shadow-Color-v0.otf?v=1.100) format("opentype");
+    src: url(../fonts/webfonts/Nupuram-Color-v0.woff2?v=1.100) format("woff2"),
+        url(../fonts/otf/Nupuram-Color-v0.otf?v=1.100) format("opentype");
 
   }
 
@@ -31,9 +34,9 @@
 
 @supports (font-palette: --custom) {
   @font-face {
-    font-family: "NupuramShadowColor";
-    src: url(../fonts/webfonts/Nupuram-Shadow-Color-v1.woff2?v=1.100) format("woff2"),
-        url(../fonts/otf/Nupuram-Shadow-Color-v1.otf?v=1.100) format("opentype");
+    font-family: "NupuramColor";
+    src: url(../fonts/webfonts/Nupuram-Color-v1.woff2?v=1.100) format("woff2"),
+        url(../fonts/otf/Nupuram-Color-v1.otf?v=1.100) format("opentype");
 
   }