Commit 6ae5b90f authored by Ciro Santilli's avatar Ciro Santilli

Improve README

- clarify that this is a library, and not just some examples
- make code organization clearer with a new header level.
    This requires using # headers for ###, so I converted everything to it
    for uniformity.
- make contributors h2. There should only be a single h1 per file.
parent 04df9e09
Freetype GL - A C OpenGL Freetype engine
========================================
# Freetype GL - A C OpenGL Freetype engine
[![Build Status](https://travis-ci.org/rougier/freetype-gl.png?branch=master)](https://travis-ci.org/rougier/freetype-gl)
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.
A small library for displaying Unicode in OpenGL using a single texture and
a single vertex buffer.
![Screenshot](http://raw.github.com/rougier/freetype-gl/master/doc/images/markup.png)
[Installation instructions](INSTALL.md).
The code is fairly simple and organized as follow:
## Code organization
Mandatory
---------
### Mandatory files
* **texture-font**: The texture-font structure is in charge of creating bitmap
glyphs and to upload them to the texture atlas.
......@@ -32,8 +29,7 @@ Mandatory
http://www.cppreference.com/wiki/container/vector/start
Optional
--------
### Optional files
* **markup**: Simple structure that describes text properties (font
family, font size, colors, underline, etc.)
......@@ -51,8 +47,7 @@ Optional
freetype.
Contributors:
=============
## Contributors
* Ryan.H.Kawicki (Initial CMake project)
* Julian Mayer (Several bugfixes and code for demo-opengl-4.cc)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment