diff --git a/Makefile b/Makefile index 8e22d0be..9e88a6aa 100644 --- a/Makefile +++ b/Makefile @@ -24,7 +24,7 @@ PEP8OPTS:=--repeat --ignore=E211,E501,E225,E301,E302,E241 \ .PHONY: all all: - @echo "Read the file INSTALL.txt to see how to build and install this package." + @echo "Read the file doc/install.txt to see how to build and install this package." .PHONY: clean clean: diff --git a/doc/changelog.txt b/doc/changelog.txt index 4f99fcd8..7e0da9d7 100644 --- a/doc/changelog.txt +++ b/doc/changelog.txt @@ -7,6 +7,10 @@ Changes: Features: - gui: Add update check for newer versions of LinkChecker. +Fixes: +- install: Fixed the install instructions to include the Qt dev tools. + Also fixed the reference to the install.txt in Makefile. + Closes: SF bug #3153484 6.1 "Christmas Vacation" (released 23.12.2010) diff --git a/doc/install.txt b/doc/install.txt index 95a95806..d2cefc5f 100644 --- a/doc/install.txt +++ b/doc/install.txt @@ -26,20 +26,26 @@ Requirements for Unix/Linux or Mac OS X On most distributions, the distutils module is included in an extra ``python-dev`` package. -3. *Optional, for bash-completion:* +3. Qt development tools + + The binary "qcollectiongenerator" is used to generate the + documentation files. + On Debian or Ubuntu systems, install the package qt4-dev-tools. + +4. *Optional, for bash-completion:* optcomplete Python module from http://furius.ca/optcomplete/ -4. *Optional, for HTML/CSS syntax checks:* +5. *Optional, for HTML/CSS syntax checks:* HTML tidy from http://utidylib.berlios.de/ cssutils from http://cthedot.de/cssutils/ -5. *Optional, for displaying country codes:* +6. *Optional, for displaying country codes:* GeoIP from http://www.maxmind.com/app/python -6. *Optional, used for Virus checking:* +7. *Optional, used for Virus checking:* ClamAv from http://www.clamav.net/ -7. *Optional, used for login form submission:* +8. *Optional, used for login form submission:* Twill from http://twill.idyll.org/ @@ -130,7 +136,12 @@ Setup for Windows - compiling from source: 8. Install InnoSetup from http://www.jrsoftware.org/isinfo.php [http://www.jrsoftware.org/download.php/is.exe] -9. Generate and execute the LinkChecker installer +9. Qt4 SDK development tools from http://qt.nokia.com/downloads + [http://get.qt.nokia.com/qtsdk/qt-sdk-win-opensource-2010.05.exe] + The binary "qcollectiongenerator.exe" is used to generate the + documentation files. + +10. Generate and execute the LinkChecker installer Change to the ``linkchecker-X.Y`` directory and run ``dist.bat`` to build a binary installer. diff --git a/doc/todo.txt b/doc/todo.txt index 713ee171..3f85e234 100644 --- a/doc/todo.txt +++ b/doc/todo.txt @@ -1 +1,2 @@ +- Only run GUI tests when X server is available (ie. DISPLAY is set) - Port to Python 3.x (will not happen anytime soon though) diff --git a/readme.txt b/readme.txt index e3acf27b..52cb8384 100644 --- a/readme.txt +++ b/readme.txt @@ -1 +1,3 @@ -See doc/html/index.html +Install documentation is at doc/install.txt +Usage documentation is at doc/html/index.txt or execute +linkchecker --help