Skip to content

Commit c8b451d

Browse files
committed
update installation instructions
1 parent dc44c28 commit c8b451d

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

README.rst

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,25 @@
44
==============
55
Installation
66
==============
7-
The latest Windows installer can be found on PyPI: https://pypi.python.org/pypi/tdl
7+
The latest Windows installers can be found on PyPI, you'll need to install the
8+
latest version of these two packages:
89

9-
If it's available you can use pip instead by running the command:
10+
* libtcod-cffi: https://pypi.python.org/pypi/libtcod-cffi
11+
* python-tdl: https://pypi.python.org/pypi/tdl
1012

11-
pip install tdl
13+
If installing from setup.py or pip you might get errors during the
14+
installation of libtcod-cffi, this can happen if your cffi module is out of
15+
date.
1216

13-
This module can also be manually installed by going into the "setup.py" directory and running the command:
17+
The recommended way to install is by using pip, but be sure to update your cffi
18+
module first, use the following commands:
1419

15-
python setup.py install
20+
pip install -U cffi
21+
pip install tdl
1622

17-
This will require that your Python installation can compile binaries.
23+
You could install manually, but you'd also have to install libtcod-cffi as well
24+
which is a binary module. This requires your Python installation to be set up
25+
with a compiler.
1826

1927
=======
2028
About
@@ -31,15 +39,15 @@ Online Documentation: http://pythonhosted.org/tdl/
3139

3240
Issue Tracker: https://github.com/HexDecimal/python-tdl/issues
3341

34-
python-tdl is a cffi port of "libtcod". You can find more about libtcod at http://roguecentral.org/doryen/libtcod/
42+
python-tdl is a cffi port of "libtcod". You can find more about libtcod at
43+
http://roguecentral.org/doryen/libtcod/
3544

3645
==============
3746
Requirements
3847
==============
3948
* Python 2.7+ or 3.x
4049
* 32 bit Windows, 32/64 bit Linux, or Mac OS/X (64 bit architecture)
4150
* libtcod-cffi: found at https://pypi.python.org/pypi/libtcod-cffi
42-
* the cffi module: found at https://pypi.python.org/pypi/cffi
4351

4452
=========
4553
License

0 commit comments

Comments
 (0)