Zomb WebDev Benchmarking Suite Files

##############################################################
############################# Zomb WebDev Benchmark v0.5.0  ##

# Program Version: 0.5.0 
# File Version: July 4th, 10:24
# Filename: readme.txt
#
# File Description: This is the general readme for the zbm.

## Released Under GPL ########################################
######################################### See zbm_info.html ##


Welcome to the Zomb WebDevelopment Benchmark!


-- Table of Contents --------------
===================================
    [1] Introduction
        [1.1] Naming Conventions
        [1.2] Methodology
    [2] Requirements
    [3] Package Contents
    [4] Setup
    [5] Contact



1. Introduction
===================================

    Zomb is pronounced "Zoom", as in Tomb. The benchmark that 
    carries this name is designed to compare the real-world 
    performance of different Web Development languages. A subset
    of the results can also be used to show the performance 
    delta between different OSs and hardware configurations as 
    well.
    
    This project is currently in Alpha state, so many of the 
    features you would expect have not bee implimented yet. The
    most significant of which is the exclusion of linux servers
    from testing; this project is being developed on Windows 
    2000 (no rants please -- certain resraints have forced this
    decision upon us). As well, only Perl and PHP tests have 
    been included. The tests for the other languages still need
    to be worked on.
    
1.1 Naming Conventions
-----------------------------------

    Chapter: a particular test scheme that is used as a 
             guideline
    zbm:     The UNIX name for the project that has been adopted
             as shorthand for the Zomb WebDev Benchmark

1.2 Methodology
-----------------------------------

    A basic methodology will be included in later releases of 
    the benchmark.
    
2. Requirements
===================================

    - Windows NT/2000 (Win98 is untested by may work)
    - Perl 5.004
    - PHP 4
    - MySQL 3.23.xx
    - a basic knowledge of Perl as well as the other languages 
        being tested
    

3. Package Contents
===================================
    
    zbm/ ------------------------------------------------
    
        - bench.cgi:    runs the benchmark
        - check.php:    used by setup.cgi to test php
        - results.cgi:  displays the results of previous tests
        - setup.cgi:    installs the zbm 
        - source.cgi:   displays the source code for chapter 
                        files (used mainly by zbm_info.html)
        - zbm.cfg:      contains configuration data for the zbm
        
    zbm/chapters ----------------------------------------
    
        - contains a folder for each language, each one 
            containing all of the tests for that lang
    
    zbm/docs --------------------------------------------
        
        - version_crumbs.txt: a log for changes to the zbm
            made during development
        - zbm.js: javascript used by the zbm for HTML
        - zbm_info.html: the main information source for the zbm
    
    zbm/results ----------------------------------------
    
        - contains the saved results for each test run (when
            "Save Results" is selected)
        
    
    zbm/temp ----------------------------------------
        
        - contains temp files created by the benchmark
    
    
    zbm/Zomb --------------------------------------------
        
        - Record.pm: Perl Module for saving result data
        - Time.pm: Perl Module for timing tests
    

4. Setup
===================================
    
    [a] Extract Files:
        - unrar the contents of the distribution file to your 
            cgi-bin directory. The files will be extracted to 
            a new folder called zbm/. If you need to FTP the 
            files, be sure to do this in ASCII mode (not binary
            of "auto-detect").
        
    [b] Set Permissions:
        - chmod 755 all .cgi and .php files
        - chmod 666 on zbm.cfg, Zomb/Time.pm, Zomb/Record.pm and
            on docs/zbm.js
        - chmod 777 on zbm/temp directory
        - chmod 777 on zbm/results directory
        
    [c] Check Perl path
        - check and possibly modify the Path to Perl. By default
            all .cgi files set the path as #!/usr/bin/perl . If
            this does not point to your installation of Perl 5
            you will need to edit this path to the correct one.
    
    [d] Edit zbm.cfg
        - read through the settings in zbm.cfg so you can edit 
            the options and settings for your own needs.
    
    [e] Run setup.cgi
        - this script was created to simplify the installation 
          process. It will let you know if there are any 
          problems before you run the benchmark itself.
    

5. Contact
===================================

    Questions, comments, tips, jars, lauds, rants, and all 
    other written communications can be sent to 
    cilanntrus@zeroworks.org.