fixed logging and more
[retroray] / libs / drawtext / README.md
1 libdrawtext
2 ===========
3
4 About
5 -----
6 Libdrawtext is a simple library for fast anti-aliased text rendering in OpenGL.
7
8 Since version 0.3 libdrawtext can also render text on plain RGBA pixel buffers.
9
10 Libdrawtext uses freetype2 for glyph rasterization. If you would rather avoid
11 having freetype2 as a dependency, you can optionally compile libdrawtext
12 without it, and use pre-rendered glyphmaps. Glyphmaps can be generated by the
13 included font2glyphmap tool, or by calling `dtx_save_glyphmap`.
14
15 See examples subdir for simple programs demonstrating libdrawtext usage, and
16 refer to the heavily commented drawtext.h header file.
17
18 - website: http://nuclear.mutantstargoat.com/sw/libdrawtext
19 - repository (git): https://github.com/jtsiomb/libdrawtext.git
20
21 Dependencies
22 ------------
23 - OpenGL (optional)
24 - freetype2 (optional): http://www.freetype.org
25
26 License
27 -------
28 Copyright (C) 2011-2019 John Tsiombikas <nuclear@member.fsf.org>  
29 You may freely use, modify and/or redistribute libdrawtext, under the terms of
30 the GNU Lesser General Public License (LGPL) version 3 (or at your option, any
31 later version published by the Free Software Foundation). See COPYING, and
32 COPYING.LESSER for details.
33
34 Build
35 -----
36 To build and install `libdrawtext` on UNIX or on Windows with MinGW, run:
37
38     ./configure
39     make
40     make install
41
42 See `./configure --help` for build-time options. 
43
44 To cross-compile for windows with mingw-w64, try the following incantation:
45
46     ./configure --prefix=/usr/i686-w64-mingw32
47     make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar sys=mingw
48     make install sys=mingw
49
50 Previous versions of this library included a visual studio project file. As I'm
51 not able to maintain it, I decided to remove it completely from this release.
52 The only way it can return in future releases, is if someone steps up to
53 maintain it. Send me an e-mail if you're interested.
54
55 Contact
56 -------
57 Feel free to send in bug reports, patches, and comments to: nuclear@member.fsf.org
58
59 Only plain text email messages, hard-wrapped at 72 columns will be accepted.