Skip to content

Commit 3dcf800

Browse files
committed
Add docs for python-tcod and python-tdl themselves.
1 parent 36c9006 commit 3dcf800

2 files changed

Lines changed: 34 additions & 1 deletion

File tree

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
master_doc = 'index'
5656

5757
# General information about the project.
58-
project = u'libtcod-cffi/tdl'
58+
project = u'python-tcod/tdl'
5959
copyright = u'2017, Kyle Stewart'
6060
author = u'Kyle Stewart'
6161

docs/glossary.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,36 @@ Glossary
2222
console defaults
2323
The default values implied by any Console print or put functions which
2424
don't explicitly ask for them as parameters.
25+
26+
libtcod-cffi
27+
python-tcod
28+
`python-tcod` is a superset of the :term:`libtcodpy` API. The major
29+
additions include class functionality in returned objects, no manual
30+
memory management, pickle-able objects, and `numpy` array attributes
31+
in most objects.
32+
33+
The `numpy` attributes in particular can be used to dynamically speed
34+
up the performance of your program compared to using :term:`libtcodpy`.
35+
36+
tdl
37+
python-tdl
38+
`tdl` is a high-level wrapper over :term:`libtcodpy` and now
39+
:term:`python-tcod`, it usually doesn't do anything that you couldn't
40+
do yourself with just :term:`libtcodpy` and Python.
41+
42+
Currently no new features are planned for `tdl`, instead new features
43+
are added to `libtcod` itself and then ported to
44+
:term:`python-tcod`.
45+
46+
libtcodpy
47+
`libtcodpy` is more or less a direct port of `libtcod`'s C API to
48+
Python. This caused a handful of issues including instances needing
49+
to be freed manually or a memory leak will occur and some functions
50+
performing badly in Python due to the need to call them frequently.
51+
52+
These issues are fixed in :term:`python-tcod` which implements the full
53+
`libtcodpy` API. If :term:`python-tcod` is installed then imports
54+
of `libtcodpy` are aliased to the `tcod` module.
55+
So if you come across a project using the original `libtcodpy` you can
56+
delete the `libtcodpy/` folder and then :term:`python-tcod` will load
57+
instead.

0 commit comments

Comments
 (0)