WIP: Updating public repo with latest version

Readme.md

@@ -1,28 +1,52 @@
-# VE Font Cache : Odin Port
+# VE Font Cache
 
 https://github.com/user-attachments/assets/b74f1ec1-f980-45df-b604-d6b7d87d40ff
 
-This is a port of the [VEFontCache](https://github.com/hypernewbie/VEFontCache) library.
-
+This started off as a port of the [VEFontCache](https://github.com/hypernewbie/VEFontCache) library to the Odin programming language.
 Its original purpose was for use in game engines, however its rendeirng quality and performance is more than adequate for many other applications.
 
+Since then the library has been overhauled to offer higher performance, improved visual fidelity, additional features, and quality of life improvements.
+
+Features:
+
+* Simple and well documented.
+* Load and unload fonts at anytime
+* Almost entirely configurabe and tunable at runtime!
+* Full support for hot-reload
+  * Clear the caches at any-time!
+* Robust quality of life features:
+  * Tracks text layers!
+  * Push and pop stack for font, font_size, colour, view, position, scale and zoom!
+  * Enforce even only font-sizing (useful for linear-zoom) [TODO]
+  * Snap-positining to view for better hinting
+* Basic or advanced text shaping via Harfbuzz
+* All rendering is real-time, triangulation done on the CPU, vertex rendering and texture blitting on the gpu.
+  * Can hand thousands of draw text calls with very large or small shapes.
+* 4-Level Regioned Texture Atlas for caching rendered glyphs
+* Text shape caching
+* Glyph texture buffer for rendering the text with super-sampling to downsample to the atlas or direct to target screen.
+* Super-sample by a font size scalar for sharper glyphs
+* All caching backed by an optimized 32-bit LRU indexing cache
+* Provides a draw list that is backend agnostic (see [backend](./backend) for usage example).
+
+Upcoming:
+
+* Support for ear-clipping triangulation
+  * Support for which triangulation method used on a by font basis?
+* Multi-threading supported job queue.
+  * Lift heavy-lifting portion of the library's context into a thread context.
+  * Synchronize threads by merging their generated layered drawlist into a file draw-list for processing on the user's render thread.
+  * User defines how context's are distributed for drawing (a basic quandrant basic selector procedure will be provided.)
+
 See: [docs/Readme.md](docs/Readme.md) for the library's interface.
 
 ## Building
 
 See [scripts/Readme.md](scripts/Readme.md) for building examples or utilizing the provided backends.
 
-Currently the scripts provided & the library itself were developed & tested on Windows. There are bash scripts for building on linux & mac.
+Currently the scripts provided & the library itself were developed & tested on Windows. There are bash scripts for building on linux (they build on WSL but need additional testing).
 
-The library depends on freetype, harfbuzz, & stb_truetype to build.  
-Note: freetype and harfbuzz could technically be gutted if the user removes their definitions, however they have not been made into a conditional compilation option (yet).
-
-## Changes from orignal
-
-* Font Parser & Glyph shaper are abstracted to their own warpper interface
-* ve_fontcache_loadfile not ported (ust use core:os or os2, then call load_font)
-* Macro defines have been coverted (mostly) to runtime parameters
-* Support for hot_reloading
-* Curve quality step interpolation for glyph rendering can be set on a per font basis.
+The library depends on harfbuzz, & stb_truetype to build.  
+Note: harfbuzz could technically be gutted if the user removes their definitions, however they have not been made into a conditional compilation option (yet).
 
 ![image](https://github.com/user-attachments/assets/2f6c0b36-179c-42fe-8903-7640ae3c209e)