plugin hidden prefs: att_remover
[clawsker.git] / README
diff --git a/README b/README
index 4bacb55..2c18b24 100644 (file)
--- a/README
+++ b/README
@@ -2,23 +2,50 @@
 Clawsker - A Claws Mail Tweaker
 -------------------------------
 
-Clawsker is a Perl-GTK2 applet to edit hidden preferences for Claws Mail.
+Clawsker is a Perl-GTK2 applet to edit hidden preferences for Claws Mail,
+and to do it in a safe and user friendly way, preventing users from raw
+editing of configuration files.
+
 Claws Mail is a fast and lightweight Mail User Agent by the Claws Mail Team.
 
+You can download the latest version from Clawsker homepage:
+
+  http://www.claws-mail.org/clawsker.php
+
 Dependencies
 ------------
 
-  Perl - http://www.perl.com
-  GTK+2 bindings for Perl - http://gtk2-perl.sourceforge.net
-  Claws Mail - http://www.claws-mail.org
+  - Building:
+
+  Nothing special: make, sed, install, gettext and pod2man.
+
+  On Debian systems and derivatives:
+  # apt-get install make sed coreutils gettext perl
+  (Although you probably already have some of these installed)
+
+  - Running:
+
+  Perl - http://www.perl.com (>= 5.10)
+  GTK+2 bindings for Perl - http://gtk2-perl.sourceforge.net (>= 1.161) built
+  with GTK+ >= 2.12 (lower GTK+ versions do not support widget tooltips and
+  a warning is issued).
+  Locale::gettext - http://search.cpan.org/~pvandry/gettext-1.05/ (>= 1.05)
+  Claws Mail - http://www.claws-mail.org (>= 3.9.1)
+
+  On Debian systems:
+  # apt-get install libgtk2-perl liblocale-gettext-perl claws-mail
 
 Install
 -------
 
 After downloading the tarball:
 
-  tar xzf clawsker-VERSION.tar.gz
-  cd clawsler-VERSION
+  tar xJf clawsker-VERSION.tar.xz
+  cd clawsker-VERSION
+  make
+
+If finished correctly, become root and:
+
   make install
 
 Replace VERSION with the actual version number of the tarball.
@@ -28,4 +55,34 @@ location (for example /usr) replace last line with:
 
   make install PREFIX=/usr
 
+Optionally you can provide also a DESTDIR as a root tree for the installation.
+
+Contributing
+------------
+
+Patches, bug fixes, and specially, new translations (or updates to the
+existing ones) are welcome. Development uses git as VCS and takes place
+on http://github.com/mones/clawsker/.
+
+Translators please read po/README file for details about translations.
+
+Bugs
+----
+
+You can send bug reports on http://github.com/mones/clawsker/issues/ list.
+Also directly by mail to me or in the Claws Mail mailing list, but the Issues
+list is the preferred way.
+
+Thanks
+------
+
+* The Claws Mail Team, for such great mail program
+* Larry Wall and all Perl hackers all over the world
+* The Perl-GTK2 folks and Phillip Vandry
+* Dirk van der Walt, for his Gtk2-Perl Study Guide [0]
+* Debian, for the Operating System
+* GitHub Inc., for providing the git hosting and more
+
+[0] http://gtk2-perl.sourceforge.net/doc/gtk2-perl-study-guide/
 
+--