Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 1.53 KB

File metadata and controls

44 lines (34 loc) · 1.53 KB

Code style

New and refactored Python code should follow the PEP 8 guidelines.

It's recommended to use an editor supporting EditorConfig.

Building python-tcod

To work with the tcod source, your environment must be set up to build Python C extensions. You'll also need cpp installed for use with pycparser.

Windows

  • Install Microsoft Visual Studio
    • When asked, choose to install the Python development tools.
  • Open a command prompt in the cloned git directory.
  • Make sure the libtcod submodule is downloaded with this command: git submodule update --init
  • Install an editable version of tcod with this command: py -m pip install --editable . --verbose

MacOS

  • Open a command prompt in the cloned git directory.
  • Install the Xcode command line tools with this command: xcode-select --install
  • Make sure the libtcod submodule is downloaded with this command: git submodule update --init
  • Install an editable version of tcod with this command: pip install --editable . --verbose

Linux

  • Open a command prompt in the cloned git directory.
  • Assuming a Debian based distribution of Linux. Install tcod's dependencies with this command: sudo apt install gcc python-dev libsdl2-dev libffi-dev
  • Make sure the libtcod submodule is downloaded with this command: git submodule update --init
  • Install an editable version of tdl with this command: pip install --editable . --verbose