update README
continuous-integration/drone/push Build is passing Details
continuous-integration/drone/pr Build is passing Details

pull/1/head
cosmonaut 2023-12-15 10:25:06 -08:00
parent 1e9d114e2b
commit 881c8317ec
1 changed files with 14 additions and 4 deletions

View File

@ -1,11 +1,21 @@
This is Wellspring, an immediate mode font rendering system in C.
This is Wellspring, an immediate mode multiple-channel signed distance field font rendering system in C.
About Wellspring
----------------
Wellspring is inspired by the design of Dear ImGui.
It outputs pixel data that you can upload to a texture and vertex buffers that you can render anytime in your 3D application.
It outputs buffer data that you can upload and render anytime in your 3D application.
This means that you can integrate it easily using the graphics library of your choice.
Wellspring uses stb_truetype to rasterize and pack fonts quickly.
Wellspring uses JSON output from [msdf-atlas-gen](https://github.com/Chlumsky/msdf-atlas-gen) to generate buffers. It also uses [stb_truetype](https://github.com/nothings/stb/blob/master/stb_truetype.h) for additional kerning support. At render time, bind the image data from msdf-atlas-gen with buffers generated by Wellspring for beautiful MSDF font rendering.
Using msdf-atlas-gen
--------------
A full explanation of msdf-atlas-gen is beyond the scope of this project, but note that Wellspring only accepts MSDF atlas types with JSON output.
Your atlas generation might look like this:
```sh
msdf-atlas-gen -yorigin top -font ~/mygame/myfont.otf -imageout ~/mygame/content/forgotten_dream.png -json ~/mygame/content/forgotten_dream.json
```
Dependencies
------------
@ -20,7 +30,7 @@ For *nix platforms, use CMake:
$ cmake ../
$ make
For Windows, see the 'visualc/' directory.
For Windows, you can use cmake-gui to generate a Visual Studio solution or use VSCode with the CMake and C/C++ Tools extensions.
License
-------