new: README.md; fix: workflow file

Author: ogswag

.github/workflows/build-font.yml

@@ -2,7 +2,7 @@ name: Build Iosevka Font
 
 on:
   push:
-    branches: [develop]
+    branches: [main]
     tags:               # Trigger on any tag push (e.g., "v1.0.0")
       - 'v*'            # Only tags starting with 'v' (semantic versioning)
   workflow_dispatch:

README.md

@@ -0,0 +1,91 @@
+# Terminality
+
+![banner](assets/banner.png)
+
+A custom monospace font based on Iosevka, tailored for JetBrains Mono enthusiasts with personalized stylistic enhancements.
+
+## Overview
+
+Terminality is a customized version of the Iosevka typeface, featuring specific design adjustments and optimizations for programming use. This font combines the best aspects of JetBrains Mono and Iosevka with personal stylistic preferences.
+
+## Features
+
+### Custom Glyph Designs:
+Modified characters include:
+  - Distinct `1` (no base)
+  - Curved `7` with crossbar
+  - Specialized `g`, `G`, `q`, `Q`, and many other characters
+  - Custom Greek letter designs
+  - Enhanced punctuation and symbols
+
+### Optimized Ligatures:
+Carefully selected programming ligatures with
+  - Special handling for operators (`<=`, `>=`, `=!=`)
+  - Center-aligned operators
+  - Disabled unnecessary ligatures for cleaner code display
+
+### Multiple Weights & Styles
+Light (300), Regular (400), Bold (700), uright and italic (12.4° angle):
+![weights](assets/weights.png)
+
+Normal and Extended widths
+![widths](assets/widths.png)
+
+**Metric Optimizations**:
+  - Custom x-height (540 units)
+  - Adjusted character spacing for terminal use
+
+## Demo
+
+### Light themes
+![light themes](assets/demo-light.png)
+
+### Dark themes
+![dark themes](assets/demo-dark.png)
+
+## Installation
+
+> [!IMPORTANT]
+> Download the latest release from the [Releases page](https://github.com/ogswag/Terminality/releases) and install the font files to your system.
+
+### Building from Source
+
+1. Clone the repository:
+```bash
+git clone https://github.com/ogswag/Terminality.git
+cd Terminality
+```
+
+2. The font will automatically build on push to the `main` branch or when creating a new tag (e.g., `v1.0.0`)
+
+3. Alternatively, you can build manually using the GitHub Actions interface.
+
+## Customization
+
+The font is built using the Iosevka build system. To customize further:
+
+1. Modify `Terminality.toml` to adjust design parameters
+2. Push changes to trigger a rebuild
+3. Download the updated font from the latest release
+
+## License
+
+- The font software is licensed under the [SIL Open Font License, Version 1.1](http://scripts.sil.org/OFL)
+- The build configuration and scripts are licensed under the MIT License
+
+## Acknowledgments
+
+- Original Iosevka typeface by Belleve Invis
+- JetBrains Mono - for being exceptionally well designed
+- Custom modifications by Alexander Zakharov (me)
+
+## Contributing
+
+Contributions and suggestions are welcome! Please open an issue or pull request to discuss changes.
+
+## Support
+
+If you encounter any issues or have questions:
+1. Check existing issues on GitHub
+2. Create a new issue with details about the problem
+3. Include screenshots if relevant to font rendering issues