###############################################################################
# #
# README - The first place to start when learning about HLmaps #
# - Copyright Scott McCrory as part of the HLmaps distribution #
# - Distributed under the GNU Public License - see docs for more info #
# - http://hlmaps.sourceforge.net #
# #
###############################################################################
# CVS $Id: README,v 1.6 2000/09/25 02:54:16 smccrory Exp $
###############################################################################
HLmaps
Copyright (C) 2000 Scott D. McCrory <smccrory@users.sourceforge.com>
All Rights Reserved
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
------------------------------------------------------------------------------
DESCRIPTION
-----------
HLmaps is a Perl/CGI script for Linux, FreeBSD and WinNT Half-Life game server
admins written by Scott McCrory. It allows web site visitors to view all your
loaded maps, screen shots, download links and some file statistics in a nice,
sortable table.
HLmaps should be pretty safe to use, as I've implemented Perl's "warn" and
"taint" modes (although NT ActiveState Perl users may need to remove the -T).
Processing loads are not very noticable now that we're using a scheduled job
to parse the logs into an interrim file or optional MySQL database, and the
run-time CGI script gets its info from this file/database when displaying the
output to the user.
REQUIRES
--------
+ Linux, FreeBSD or WinNT
+ Perl 5.0+ (Ships with nearly every *nix distribution) or ActiveState's
Perl for WinNT)
+ Web server supporting CGI (Apache extensively tested)
+ MySQL if you optionally want to use a database as the interrim data store
+ Half-Life Server software (well duh!)
DOWNLOADING
-----------
Home page:
http://hlmaps.sourceforge.net
INSTALLING
----------
Please read the INSTALL file in this package for installation and upgrade info.
CONTRIBUTING
------------
If you're interested in contributing to HLmaps, by all means study this
package and check out the home page at http://hlmaps.sourceforge.net where
you'll find a link to the CVS tree, developer mailing lists, etc. I sure
could use help with everything from bug fixes to additional map images to
additional platform ports to documentation to optimizing code to
adding features...!
--
Hope you enjoy!
Scott and the HLmaps development team.
