Skip to content

Commit 2a4007e

Browse files
committed
updated the readme since for newer users it will be less clear how to install this package after the move to GitHub
1 parent 148709d commit 2a4007e

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

README.txt

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
==============
2+
Installation
3+
==============
4+
The latest Windows installer can be found on PyPI:
5+
https://pypi.python.org/pypi?name=tdl&:action=display
6+
7+
Or if it's available you can use pip instead by running the command:
8+
pip install tdl
9+
10+
This module can also be manually installed by going into the "setup.py"
11+
directory and running the command:
12+
python setup.py install
13+
14+
Already compiled libtcod libraries are included as part of the package data.
15+
They won't need to be compiled as part of the installation, but can be replaced
16+
with newer versions if necessary.
17+
118
=======
219
About
320
=======
@@ -7,14 +24,17 @@ The library can be used for displaying tilesets (ANSI, Unicode, or graphical) in
724

825
It also provides functionality to compute path-finding and field of view.
926

10-
python-tdl is hosted on GitHub: https://github.com/HexDecimal/python-tdl
27+
python-tdl is hosted on GitHub:
28+
https://github.com/HexDecimal/python-tdl
1129

12-
Online Documentation: http://pythonhosted.org/tdl/
30+
Online Documentation:
31+
http://pythonhosted.org/tdl/
1332

14-
Issue Tracker: https://github.com/HexDecimal/python-tdl/issues
33+
Issue Tracker:
34+
https://github.com/HexDecimal/python-tdl/issues
1535

1636
python-tdl is a ctypes port of "libtcod".
17-
You can find more about libtcod at: http://doryen.eptalys.net/libtcod/
37+
You can find more about libtcod at http://doryen.eptalys.net/libtcod/
1838

1939
==============
2040
Requirements

0 commit comments

Comments
 (0)