docs/README

   1 htag.pl 0.0.18
   2 Simon Huggins <huggie@earth.li>
   3
   4 Description
   5 ===========
   6
   7         htag is a tagline adder but it has now been so over engineered that
   8         it will also do anything you want it to[0], do lots of stuff I want
   9         it to[1], and do stuff it wants to[2].
  10
  11 See the INSTALL file for basic usage.
  12 See the TODO    file for some stuff that I need help with and stuff that
  13 will appear soon.
  14
  15 You will probably find the other docs useful (in order of usefulness):
  16 README                  - This file!
  17 INSTALL                 - how to install and use.
  18 README.Multiple_Configs - How to use multiple config files (you probably
  19                           want to use this to get any use of the
  20                           power/configurability of htag)
  21 sample-config           - a bunch of sample config files useful to base
  22                           yours on.
  23 WRITING_SIGS            - tips for writing your own signatures.
  24 TROUBLESHOOTING         - how to troubleshoot your own problems.
  25 MACRO_DESCRIPTION       - the reference for all the magic in sigs and tags.
  26 Changelog.htag          - the changes between versions of htag.
  27 Changelog.htagplugin    - the changes between versions of the HtagPlugin module.
  28 URL                     - URL of homepage.
  29 BUGS                    - list of known bugs and what to do if you find one.
  30 TODO                    - list of outstanding tasks.
  31 AUTHORS                 - list of contributors.
  32 LICENSE                 - the license.
  33
  34
  35 Please mail me if you:
  36 * have written some cool/useful plugins
  37 * want to write docs
  38 * want me to write docs
  39 * want to write an installer
  40 * think it's good
  41 * want to show off your tags and sigs :)
  42
  43 I'm interested in anyone running this successfully under windows.  I imagine
  44 it should work with a bit of hackery.
  45
  46
  47 [0] If you write the plugins to do it.
  48 [1] that should be there already or should appear in future releases.
  49 [2] Well ok that's just a blatent lie.
  50
  51 Simon Huggins <huggie@earth.li>