linkchecker/doc/development.txt
2013-02-08 21:36:02 +01:00

66 lines
2.1 KiB
Text

Developing LinkChecker
======================
The following steps describe how to compile LinkChecker from source
on various platforms.
Requirements
------------
On Mac OS X systems, using MacPorts, Fink or homebrew for software
installation is recommended.
- Install Python >= 2.7.2 from http://www.python.org/
- Qt4 SDK development tools from http://qt.nokia.com/downloads
The binary "qcollectiongenerator" is used to generate the
documentation files.
- Install PyQt >= 4.8 from
http://www.riverbankcomputing.co.uk/software/pyqt/download
- *Optional, for syntax highlighting in the GUI editor*, install
QScintilla from
http://www.riverbankcomputing.co.uk/software/qscintilla/download
- *On Windows only*, install the Windows SDK
http://msdn.microsoft.com/de-de/windows/bb980924
- *On Windows only*, install InnoSetup from
http://www.jrsoftware.org/isinfo.php
- *On Windows only*, download and install the Microsoft
Visual C++ 2008 runtime from
http://www.microsoft.com/downloads/details.aspx?FamilyID=9b2da534-3e03-4391-8a4d-074b9f2bc1bf&displaylang=en
- *Optional, used for Virus checking:*
ClamAv for Unix from http://www.clamav.net/lang/en/download/
or for Windows from http://www.sosdg.org/clamav-win32/
- *Optional, for displaying country codes:*
Pygeoip from http://code.google.com/p/pygeoip/
- *Optional, used for login form submission:*
Twill from http://twill.idyll.org/
Setup for Unix/Linux
--------------------
Execute ``make localbuild`` to compile a local version and execute
``./linkchecker`` or ``./linkchecker-gui``.
Execute ``make test`` to run the unittest suite.
Execute ``make dist`` to build a distributable source package.
Setup for Mac OS X
------------------
Execute ``make localbuild`` to compile a local version and execute
``./linkchecker`` or ``./linkchecker-gui``.
Execute ``make test`` to run the unittest suite.
Execute ``make app`` to build a distributable source package.
Setup for Windows
-----------------
Execute ``windows\build.bat`` to build a local version.
Execute ``windows\test.bat`` to run the unittest suite.
Execute ``windows\dist.bat`` to build a binary installer.