README, Makefile, and license headers
[gph-cmath] / README.md
1 gph-cmath: C math library for graphics
2 ======================================
3
4 About
5 -----
6 gph-cmath is a C math library for graphics programs. It provides a plethora of
7 operations on vectors, matrices and quaternions, among other things.
8
9 It's conceptually a companion to my C++ math library
10 [gph-math](http://github.com/jtsiomb/gph-math), but where gph-math is designed
11 with intuitiveness and ease of use as the main priority, this C version is
12 designed to be as low-overhead as possible, making it more suitable for more
13 resource-constrained target systems.
14 For instance most functions modify their first argument, instead of doing an
15 extra copy to provide a more natural 3 operand interface. Leaving the copy to
16 the user for the cases where it's necessary.
17
18 License
19 -------
20 Copyright (C) 2016 John Tsiombikas <nuclear@member.fsf.org>
21
22 This program is free software. Feel free to use, modify, and/or redistribute it
23 under the terms of the MIT/X11 license. See LICENSE for details.
24
25 How to use
26 ----------
27 There's nothing to build. All functions are static inline, defined in the header
28 files. Either type `make install` to install them system-wide, or just copy all
29 files under `src/` to your project source tree.