]> the.earth.li Git - htag.git/blob - docs/README
Import Upstream version 0.0.23
[htag.git] / docs / README
1 htag.pl 0.0.23
2 Simon Huggins <huggie@earth.li>
3
4 Description
5 ===========
6
7         htag is a tagline and signature adder but it has now been so over
8         engineered that it will also do anything you want it to[0], do lots
9         of stuff I want 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 htag for those not using a binary
18                           package.
19 sample-config           - a bunch of sample config files useful to base
20                           yours on.
21
22 But really most of the docs are now at:
23 http://the.earth.li/~huggie/cgi-bin/moin/HtagHowto
24
25 Other docs are:
26 TROUBLESHOOTING         - how to troubleshoot your own problems.
27 MACRO_DESCRIPTION       - the reference for all the magic in sigs and tags.
28 Changelog.htag          - the changes between versions of htag.
29 Changelog.htagplugin    - the changes between versions of the HtagPlugin module.
30 URL                     - URL of homepage.
31 BUGS                    - list of known bugs and what to do if you find one.
32 TODO                    - list of outstanding tasks.
33 AUTHORS                 - list of contributors.
34 LICENSE                 - the license.
35
36
37 Please mail me if you:
38 * have written some cool/useful plugins
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>