Change policy about how we handle generated files
[amule.git] / src / utils / amps / README
blob582accf292621cd85a2f9b018249b86df7c4511d
1 AMPS - AMule PHP Statistics
3 Copyright (c) 2004-2011 Matt Britt ( uberpenguin@hotpop.com )
4 Thanks to BigBob for writing the original aStats, which inspired this script
6 To use AMPS, just copy this entire directory somewhere under your HTTP
7 server's document root. AMPS requires that your PHP binaries have been
8 compiled with GD and FreeType support (configure options '--with-gd[=DIR]
9 --enable-gd-native-ttf'). Since AMPS has to access files outside the document
10 root of your webserver (specifically the aMule signature file), the safe_mode
11 option in your '/etc/php.ini' MUST be set to 'off'. If you want AMPS to display
12 in a different language, append '?lang=xx' to the 'index.php' file where 'xx' is
13 the two-letter country code (assuming that translation exists) such as en, de,
14 fr, etc. If you input a country code the script does not recognize, it will
15 simply default to en. Or you could just use the handy language selection drop-
16 down list at the bottom of the page!
18 AMPS looks for the aMule signature file (amulesig.dat) in /tmp. So make sure
19 amulesig.dat is actually being written to /tmp (the default is ~/.aMule).
21 If you would like to add a translation in your language, open the file 'en.inc'
22 in the 'langs/' directory, translate all the strings, and save the translated
23 file as 'xx.inc' where 'xx' is the two-leter language code (en, fr, etc). That's
24 it! Also, you probably will want to add the two-letter language code to the
25 array $completedlangs that is set near the top of 'index.php'. If you produce a
26 translation, please be sure to send it to me for inclusion in the main
27 distribution!
29 Sometime in the near future I will complete the theme support I have stubbed
30 into the script. If you have a colour scheme that you think looks good, modify
31 'style.css' and be sure to send me a copy of your new syle so I can include it
32 in future versions!
34 Please send any bugs, translations, or verbal abuse to <uberpenguin@hotpop.com>
36 Questions or comments regarding translations can be directed to the respective
37 translators listed in the CHANGELOG file.