README.md@87e3bb5086e8 (annotated)
README.md
Mon, 20 Apr 2020 10:14:32 -0500
- author
- Tuomo Valkonen <tuomov@iki.fi>
- date
- Mon, 20 Apr 2020 10:14:32 -0500
- changeset 119
- 87e3bb5086e8
- parent 107
- README@da2a985da6ee
- permissions
- -rw-r--r--
Convert README to markdown
| 53 | 1 | |
| 119 | 2 | # libtu |
| 53 | 3 | |
| 119 | 4 | Written 1999–2007 by Tuomo Valkonen <tuomov@iki.fi> |
| 0 | 5 | |
| 119 | 6 | Libtu is a small utility library for programs written in C, used by my old C codes. |
| 65 | 7 | |
| 8 | Most of this library may be distributed and modified under either under | |
| 119 | 9 | the Clarified Artistic License or the GNU LGPL, version 2.1 or later, |
| 65 | 10 | both reproduced in the file LICENSE. The red-black tree code is under |
| 119 | 11 | the GNU LGPL; see `README.rb` for details. |
| 0 | 12 | |
| 3 | 13 | To build the library, first edit system.mk to customize it for your |
| 119 | 14 | system if necessary. Then `make depend && make`. |
| 15 | To install it run `make install` (perhaps as root depending on | |
| 0 | 16 | where you are installing it). |
| 17 | ||
| 18 | If you want to use it in your programs, you may try to figure out how | |
| 119 | 19 | by reading the header files (`include/*.h`) and test programs (`tester*.c`). |
| 0 | 20 | Or you could try urging me to write some sort of a manual. |
| 25 | 21 | |
| 119 | 22 | ## Requisites |
| 25 | 23 | |
| 24 | Libtu needs the functions asprintf and vasprintf. These do not | |
| 35 | 25 | exist on most platforms. One implementation by Mark Martinec |
| 119 | 26 | is included in `snprintf_2.2/` and is used by default. To use the |
| 35 | 27 | system's versions of these functions, if available, modify |
| 28 | system.mk. | |
| 25 | 29 | |
| 107 | 30 | The implementation of red-black trees is based on that by |
| 119 | 31 | James S. Plank; see `README.rb` for details. |
