diff --git a/README b/README index 8479d420b..87b9af82a 100644 --- a/README +++ b/README @@ -1,86 +1 @@ -Welcome and thanks for trying out Gajim. - -=RUNTIME REQUIREMENTS= - * python2.4 or higher - * pygtk2.6 or higher - * python-libglade - * pysqlite2 (if you have python 2.5, you already have this) - -some distros also split too much python standard library. -I know SUSE does. In such distros you also need python-xml -the xml lib that *comes* with python and not pyxml or whatever - -=COMPILE-TIME REQUIREMENTS= - * python-dev - * python-gtk2-dev - * libgtk2.0-dev # aka. gtk2-devel - * libxss-dev # for idle detection module (Some distributions (f.e. Debian) split xscreensaver) - * libgtkspell-dev # for gtkspell module - * intltool - -NOTE: -If you still have problems compiling, you may want to try removing the gtk1 series of the above dependencies - -Optionally: - * dnsutils (or whatever package provides the nslookup binary) for SRV support; if you don't know what that is, you don't need it - * gtkspell and aspell-LANG where lang is your locale eg. en, fr etc - * GnomePythonExtras 2.10 or above (aka gnome-python-desktop) so you can avoid compiling trayicon and gtkspell - * gnome-python-desktop (for GnomeKeyring support) - * notification-daemon or notify-python (and D-Bus) to get cooler popups - * D-Bus to have gajim-remote working - -NOTE TO PACKAGERS: -Gajim is a GTK+ app and not a gnome one. -Just do 'make' so you don't require gnomepythonextras -which is gnome dep - -=INSTALLATION PROCEDURE= -tar jxvf gajim-version.tar.bz2 -cd gajim -make # builds all modules -su -c make install - -To specify what modules to build do: -make help - -To specify where to install do: -su -c make PREFIX=custom_path install - -=RUNNING GAJIM= -gajim - -or if you didn't 'make install' you can also run from gajim folder with -./launch.sh - -Last but not least, you can run Gajim from your GNOME/XFCE/KDE/whatever menus. - -=UNINSTALLATION PROCEDURE= -su -c make uninstall -this will try to remove Gajim from the default directories. -If you want to remove it from custom directory provide it as: -make PREFIX=custom_path uninstall - -=MISCELLANEOUS= -XML & Debugging: -If you want to see the xml stanzas and/or help us debugging -you're advised to enable verbose via advanced configuration window. -If you don't want to make this permanent, execute gajim with --verbose -everytime you want to have verbose output. - -=FAQ/Wiki= -FAQ can be found at http://trac.gajim.org/wiki/GajimFaq -Wiki can be found at http://trac.gajim.org/wiki - - -That is all, enjoy! - -(C) 2003-2006 -The Gajim Team -http://gajim.org - - -PS. -We use original art and parts of sounds and other art from Psi, Gossip, -Gnomebaker, Gaim and some icons from various gnome-icons -(mostly Dropline Etiquette) we found at art.gnome.org -If you think we're violating a license please inform us. Thank you +see README.html diff --git a/README.html b/README.html new file mode 100644 index 000000000..6f4827a4e --- /dev/null +++ b/README.html @@ -0,0 +1,130 @@ + + + + Gajim - Read Me + + + +

Gajim Read Me

+ +

+Welcome to Gajim and thank you for trying out our client. +

+ +

Runtime Requirements

+ + +

+Note to packagers +Gajim is a GTK+ app that loves GNOME. You can do 'make' so you don't require gnomepythonextras (aka gnome-python-desktop) which is gnome dep, but you will miss gnomekeyring intergration. +

+ +

Optional Runtime Requirements

+ + +

+Some distributions also split too much python standard library. +I know SUSE does. In such distros you also need python-xml +the xml lib that *comes* with python and not pyxml or whatever. +

+ +

Compile-time Requirements

+ + +

+NOTE: +If you still have problems compiling, you may want to try removing the gtk1 series of the above dependencies. +

+ +

Installation Procedure

+
    +
  1. tar jxvf gajim-version.tar.bz2
    2. +cd gajim +make (builds all modules) +su -c make install +
+ +

+To specify what modules to build do: +make help +

+ +

+To specify where to install do: +su -c make PREFIX=custom_path install +

+ +

Running Gajim

+

+Just do gajim or you can run Gajim from your GNOME/XFCE/KDE/whatever menus.

+ +or if you didn't 'make install' you can also run from gajim folder with +./launch.sh +

+ +

Uninstallation Procedure

+

+su -c make uninstall
+this will try to remove Gajim from the default directories. +If you want to remove it from custom directory provide it as:
+make PREFIX=custom_path uninstall +

+ +

Miscellaneous

+

XML & Debugging

+

+If you want to see the xml stanzas and/or help us debugging +you're advised to enable verbose via advanced configuration window. +If you don't want to make this permanent, execute gajim with --verbose +everytime you want to have verbose output. +

+ +

FAQ/Wiki

+

+FAQ can be found at http://trac.gajim.org/wiki/GajimFaq +Wiki can be found at http://trac.gajim.org/wiki +

+ + +

+That is all, enjoy! +

+ +

+
+
+
+(C) 2003-2006
+The Gajim Team
+http://gajim.org
+
+
+ +PS. +We use original art and parts of sounds and other art from Psi, Gossip, +Gnomebaker, Gaim and some icons from various gnome-icons +(mostly Dropline Etiquette) we found at art.gnome.org +If you think we're violating a license please inform us. Thank you. +

+