- added libdrawtext

[demo_prior] / libs / drawtext / README.md

diff --git a/libs/drawtext/README.md b/libs/drawtext/README.md
new file mode 100644 (file)
index 0000000..b4ac23a
--- /dev/null
+++ b/libs/drawtext/README.md
@@ -0,0 +1,59 @@
+libdrawtext
+===========
+
+About
+-----
+Libdrawtext is a simple library for fast anti-aliased text rendering in OpenGL.
+
+Since version 0.3 libdrawtext can also render text on plain RGBA pixel buffers.
+
+Libdrawtext uses freetype2 for glyph rasterization. If you would rather avoid
+having freetype2 as a dependency, you can optionally compile libdrawtext
+without it, and use pre-rendered glyphmaps. Glyphmaps can be generated by the
+included font2glyphmap tool, or by calling `dtx_save_glyphmap`.
+
+See examples subdir for simple programs demonstrating libdrawtext usage, and
+refer to the heavily commented drawtext.h header file.
+
+- website: http://nuclear.mutantstargoat.com/sw/libdrawtext
+- repository (git): https://github.com/jtsiomb/libdrawtext.git
+
+Dependencies
+------------
+- OpenGL (optional)
+- freetype2 (optional): http://www.freetype.org
+
+License
+-------
+Copyright (C) 2011-2019 John Tsiombikas <nuclear@member.fsf.org>  
+You may freely use, modify and/or redistribute libdrawtext, under the terms of
+the GNU Lesser General Public License (LGPL) version 3 (or at your option, any
+later version published by the Free Software Foundation). See COPYING, and
+COPYING.LESSER for details.
+
+Build
+-----
+To build and install `libdrawtext` on UNIX or on Windows with MinGW, run:
+
+    ./configure
+    make
+    make install
+
+See `./configure --help` for build-time options. 
+
+To cross-compile for windows with mingw-w64, try the following incantation:
+
+    ./configure --prefix=/usr/i686-w64-mingw32
+    make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar sys=mingw
+    make install sys=mingw
+
+Previous versions of this library included a visual studio project file. As I'm
+not able to maintain it, I decided to remove it completely from this release.
+The only way it can return in future releases, is if someone steps up to
+maintain it. Send me an e-mail if you're interested.
+
+Contact
+-------
+Feel free to send in bug reports, patches, and comments to: nuclear@member.fsf.org
+
+Only plain text email messages, hard-wrapped at 72 columns will be accepted.