Commit 3b8f6921 authored by Jan Niklas Hasse's avatar Jan Niklas Hasse
Browse files

Use Markdown for README file

parent 873c0772
Loading
Loading
Loading
Loading
+22 −21
Original line number Diff line number Diff line
@@ -5,41 +5,42 @@ This code intends to show how to display fonts efficiently using regular C,
Freetype and OpenGL. The idea is to use a single texture and a single vertex
buffer. The code is fairly simple and organized as follow:

** mandatory **
Mandatory
---------

texture-font:  The texture-font structure is in charge of creating bitmap
* **texture-font**:  The texture-font structure is in charge of creating bitmap
                     glyphs and to upload them to the texture atlas.

texture-atlas: This structure is responsible for the packing of small regions
               into a bigger texture. It is based on the skyline bottom left
               algorithm which appear to be well suited for storing glyphs.

               More information at:
* **texture-atlas**: This structure is responsible for the packing of small
                     regions into a bigger texture. It is based on the skyline
                     bottom left algorithm which appear to be well suited for
                     storing glyphs. More information at:
                     http://clb.demon.fi/files/RectangleBinPack.pdf

vector:        This structure loosely mimics the std::vector class from c++. It
               is used by texture-atlas (for storing nodes), texture-font (for
               storing glyphs) and font-manager (for storing fonts).

               More information at:
* **vector**:        This structure loosely mimics the std::vector class from
                     c++. It is used by texture-atlas (for storing nodes),
                     texture-font (for storing glyphs) and font-manager (for
                     storing fonts). More information at:
                     http://www.cppreference.com/wiki/container/vector/start


** optional ***
Optional
--------

markup:        Simple structure that describes text properties (font family,
               font size, colors, underline, etc.)
* **markup**:        Simple structure that describes text properties (font
                     family, font size, colors, underline, etc.)

font-manager:  Structure in charge of caching fonts.
* **font-manager**:  Structure in charge of caching fonts.

vertex-buffer: Generic vertex buffer structure inspired by pyglet (python).
               (more information at http://www.pyglet.org)
* **vertex-buffer**: Generic vertex buffer structure inspired by pyglet
                     (python). (more information at http://www.pyglet.org)

edtaa3func:    Distance field computation by Stefan Gustavson
* **edtaa3func**:    Distance field computation by Stefan Gustavson
                     (more information at http://contourtextures.wikidot.com/)

makefont:      Allow to generate header file with font information (texture + glyphs)
               such that it can be used without freetype.
* **makefont**:      Allow to generate header file with font information
                     (texture + glyphs) such that it can be used without
                     freetype.


Contributors: