Read Me

eGuideDog Browser is a browser designed mainly for the blind.
It's written in Perl and run on Linux.
Website: http://e-guidedog.sf.net/

===== Install =====
$tar zxvf e-guidedog-{version}.tar.gz
$cd e-guidedog
$./install

There will be questions from CPAN for install Perl modules during the installation. When you encounter a question "Are you ready for manual configuration? [yes]", you can answer "no" which make things easier but slower. You can answer yes if you know what's happening. Answer "yes" for the rest questions.

Run `e-guidedog` to launch the programme.
If this is not work, see section "Further Information About Install"

===== Usage =====
Press 'q' to quit the program. Please run the following to get other help
$e-guidedog

===== License =====
eGuideDog is distributed with GPL v2 license. see LICENSE
However, the software itself use many other third party softwares. Further investigation should be done if anyone wants to re-distribute it as a commercial software.

===== Author =====
Cameron Wong (http://e-guidedog.sourceforge.net/contact.php)

===== Report Bugs =====
Run `e-guidedog` with parameter '2>error.log' at the end.
Get my email address on my contact page.
Send me an email with the log and describe in what circumstance it will happen.

There are such known bugs:
1. There is "Scalars leaked" when using bookmark to open page.

===== Further Information About Install =====
I build the software under Ubuntu Linux 6.10. If you are using other system, you may encount more unexpected problems. Just email me if you have enough patience:)

Possible problems are as follows:

1) You haven't install eSpeak properly.
   Get it from http://espeak.sf.net
   Maybe you should link the share library libespeak.so yourself if it doesn't install to the standard LIB path for you.
   If you want Chinese support, you should download the latest one from http://sourceforge.net/project/showfiles.php?group_id=184512&package_id=252727
   I am sorry Festival is not supported now although I supported it before. Just because I haven't enough time to mantain so much. I may re-support it in future.

2) You haven't install Curses development files.
   For Ubuntu users, just run `sudo apt-get install libncursesw5-dev`.
   You can build from source too.

3) UTF-8 (Chinese for example) cannot display in the virtual terminal.
   The default Curses in Perl is not support wide character. You should compile it yourself if you want to support Chinese. Here is the procedure:
   1. download Curses-1.13.tgz(choose your proper version according to your library) from CPAN
   2. $tar zxvf Curses-1.13.tgz && cd Curses
   3. $cp hints/c-linux.ncurses.h c-config.h
   4. perl Makefile.PL CURSES_CFLAGS="-I/usr/include/ncurses" CURSES_LDFLAGS="-L/usr/lib -lncursesw"
   5. make
   6. make install
   Your Curses will support wide character from now on:)

4) Wget - The non-interactive network downloader
   I guess you already have. In case not, get it from http://www.gnu.org/software/wget/