Skip to content

Commit

Permalink
update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
HexDecimal committed Dec 20, 2015
1 parent dc44c28 commit c8b451d
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,25 @@
==============
Installation
==============
The latest Windows installer can be found on PyPI: https://pypi.python.org/pypi/tdl
The latest Windows installers can be found on PyPI, you'll need to install the
latest version of these two packages:

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

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

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

python setup.py install
pip install -U cffi
pip install tdl

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

=======
About
Expand All @@ -31,15 +39,15 @@ Online Documentation: http://pythonhosted.org/tdl/

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

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

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

=========
License
Expand Down

0 comments on commit c8b451d

Please sign in to comment.