Skip to content

Commit 368c4d4

Browse files
committed
Update README and COPYING.
1 parent 6ce7df0 commit 368c4d4

File tree

2 files changed

+60
-2
lines changed

2 files changed

+60
-2
lines changed

COPYING

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (C) 2010-2011 nsf <[email protected]>
1+
Copyright (C) 2010-2013 nsf <[email protected]>
22

33
Permission is hereby granted, free of charge, to any person obtaining a copy
44
of this software and associated documentation files (the "Software"), to deal

README

+59-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,62 @@
11
Termbox is a library that provides minimalistic API which allows the
22
programmer to write text-based user interfaces.
33

4-
TODO: more stuff here.
4+
TODO: better intro.
5+
6+
CHANGES
7+
=======
8+
9+
VERSION 1.0.0
10+
-------------
11+
- Remove the Go directory. People generally know about termbox-go and where
12+
to look for it.
13+
- Remove old terminfo-related python scripts and backport the new one from
14+
termbox-go.
15+
- Remove cmake/make-based build scripts, use waf.
16+
- Add a simple terminfo database parser. Now termbox prefers using the
17+
terminfo database if it can be found. Otherwise it still has a fallback
18+
built-in database for most popular terminals.
19+
- Some internal code cleanups and refactorings. The most important change is
20+
that termbox doesn't leak meaningless exported symbols like 'keys' and
21+
'funcs' now. Only the ones that have 'tb_' as a prefix are being exported.
22+
- API: Remove unsigned ints, use plain ints instead.
23+
- API: Rename UTF-8 functions 'utf8_*' -> 'tb_utf8_*'.
24+
- API: TB_DEFAULT equals 0 now, it means you can use attributes alones
25+
assuming the default color.
26+
- API: Add TB_REVERSE.
27+
- Move python module to its own directory and update it due to changes in the
28+
termbox library.
29+
30+
31+
INSTALLATION
32+
============
33+
34+
Termbox comes with a waf-based build scripts. In order to configure, build and
35+
install it, do the following:
36+
37+
./waf configure --prefix=/usr (configure)
38+
./waf (build)
39+
./waf install --destdir=DESTDIR (install)
40+
41+
By default termbox will install the header file and both shared and static
42+
libraries. If you want to install a shared library or static library alone, use
43+
the following as an install command:
44+
45+
./waf install --targets=termbox_shared --destdir=PREFIX (shared library)
46+
or
47+
./waf install --targets=termbox_static --destdir=PREFIX (static library)
48+
49+
50+
PYTHON
51+
------
52+
53+
In order to install the python module, use the following command (as root or
54+
via sudo):
55+
56+
python setup.py install
57+
58+
BUGS & QUESTIONS
59+
================
60+
61+
Report bugs to the https://github.com/nsf/termbox issue tracker. Send rants
62+
and questions to me: [email protected].

0 commit comments

Comments
 (0)