dump

README.md

@@ -1,2 +1,44 @@
-# samantarik-public
+# সামান্তরিক / samantarik
 
+![samantarik](./docs/samantarik.png)
+
+A Monospace Bangla font experiment.
+
+## Notes
+
+> [!WARNING]
+> this is a prototype, dont blame me if your display explodes.
+
+naming pattern: `SamantarikProto<Mode><Scale><Variant>-<Weight>`
+
+eg, SamantarikProto-G75se-Regular.ttf -> mode: G, scale: 75, variant: s and e, weight: Regular
+
+Modes:
+
+- **B**: 1 cells per codepoint, consonants and vowels 1, stacked marks and hasant 0
+- **C**:	1 cells per cluster
+- **W**:	`min(2, B)` cells per cluster
+- **G**: `B` cells per cluster, `W` cells display
+- **T**: `min(max(2, B), 2)` cells per cluster
+- **U**: 2 cells per cluster
+
+Variants:
+
+- (blank): centered: shaped cluster centered on cells
+- **s**: spread: cluster components spread out over cells
+- **f**: fill: cluster widened to fill cells
+- **e**: extended x-height for (sliightly) better balance with latin text
+
+**C** seems to work best so far with kitty and neovim (vim doesnt like any of these).
+
+Editing is often broken. Issues and suggestions always welcome.
+
+## Source code, documentation, build pipeline
+
+look over there -> *\*hides\**
+
+## License
+
+TBD.
+
+based on [Anek Bangla](https://github.com/EkType/Anek)'s glyphs which is [OFL-licensed](./docs/OFL-anek.txt).