Developer steps

Run from source

To modify and run CSnake from source, we recommend using Eclipse (see Developing with Eclipse).

1. Install the prerequisites listed in Install and Run and wxPython version 2.8 (download 2.8.12.1-win64 or 2.8.12.1-win32)
2. Either:
   • Checkout the CSnake repository using a Git client,
   • Download the zip file from the downloads page.
3. Execute the application from the location where the repository was checkout out in the directory src by:
   • typing the following command line: python csnGUI.py,
   • double click on the csnGUI.py file from the file explorer on Microsoft Windows.

Documentation

The documentation is generated using Doxygen. Just run doxygen with the doc/Doxyfile.doxy file to create the html help.

Installer

In order to create a Microsoft Windows CSnake installer, we first need to create an executable. For this we use py2exe (WARNING: can only be installed if the path to python does not contain spaces...). The script relies on the documentation to have been created first (see previous step). Now you can either use the bat file build/createWindowsExecutable.bat or run directly: python ../src/setup.py py2exe.

The installer is created using NSIS. A configuration is saved in build/csnake.nsi.

---

Back to the Developer Guide.