Overview

1. About StatHG
---------------
    StatHg generates statistical report graphs from the Mercurial activity log. 
    The generated report is independent of the application and can be freely 
    transferred or even published using a web server. This version includes the
    following reports:

    * Graphs by Project (repository)
        * Total Modified Lines of Code Per Day
        * Accumulated Lines of Code Per Date
        * Commit Activity
        * Commit Activity by Hour of Day
        * Commit Activity by Day of Week
    * Graphs by Developer
        * Commit Activity by Hour of Day
        * Commit Activity by Day of Week    

2. System Requirements
----------------------
    The following minimum hardware and software requirements are needed:

    * A 1.4GHz Pentium 4-class processor or faster.
    * 256 MB RAM.
    * At least 5MB free disk space on the install partition.
    * At least 100MB free disk space on the system temporary storage partition.
    * Oracle JRE version 1.6 or later.
    * Mercurial Distributed SCM version 1.7 or later.

    These requirements are estimated for a reasonably fast report generation 
    (approx. 2 minutes) and for a 2500-change-set sized repository, so it will 
    vary according to the size of the used repository. The report generation 
    performance is directly related to the amount of change-sets to process.

3. Installation Procedure
-------------------------
    The application is distributed on a ZIP archive containing all the files 
    necessary to run it. Please follow the following steps to install the
    application:

    1. Unzip the file contents to an appropriate directory using whichever tool
       you may have available.
       
       On Microsoft Windows Systems, right click on the compressed file and 
       select the Extract All.. option, then follow the on-screen instructions 
       to decompress the file's contents.
       
       On Unix-based systems, you can use the unzip command-line tool or your 
       desktop environment's integrated file compression tool to decompress the 
       file's contents. You may also need to make the StatHg launcher shell 
       script executable by running  the command chmod +x stathg on the 
       directory where you decompressed the program files.


3. Command-line tool usage
--------------------------
    Command-line tool usage
    The command line tool expects 3 required parameters, and several optional:

    $> stathg generate html (REPO_ADDRESS|LOG_PATH) [-v] [-l OUTPUT_PATH] [-o] 
    [-r START_DATE,END_DATE]

    REPO_ADDRESS should point to a HTTP, HTTPS and SSH addresses. Otherwise, 
    the provided argument will be considered a file path to a Mercurial log 
    dump. 

    -h    Prints out the command-line help.
    -v    Produces more detailed information while generating the reports.
    -l    Writes the report onto OUTPUT_PATH. If the path points to an existing
          folder, the report will be written on a file inside that directory 
          with a default name designated by the output module (e.g. index.html).
          Otherwise, the report will be output to a file with the specified 
          path and name. If this modifier is missing the report will be written 
          onto the current working directory. Note that paths containing spaces 
          have to be enclosed in quotes.
          Example -l d:\project\report\
          Example -l "d:\project outputh\report\" 
    -o    Overrides the report file if it already exists. By default, the 
          application will not overwrite an existent report and will print out
          an error instead.
    -r    Produces the report considering only the change-sets sent of the 
          specific period, that is to say, on any day between START_DATE and 
          END_DATE (inclusive both ways). By default, all the change-sets on 
          the repository or log will be considered, regardless of their date.
          NOTE: This modifier does not set the range of the dates between which 
          the charts will be drawn; it merely limits the amount of information 
          that is considered while building the report. The chart date range 
          will be automatically calculated by the application to optimize the 
          scale.

4. Contributors
---------------
    StatHg was developed by multiple students and monitors (teachers) at 
    the Fundacion Jala (http://fundacion-jala.org):
    
    Willian Silisque
    Marcos Montaño
    Ronald Duenas
    Javier Perez
    Jose Alvarez
    Gary Maranon
    Juan Antezana Adrian
    Jonatan Osvaldo Lijeron Parrilla
    Zeida Rocio Ayala Pacheco
    Daniel Pariente
    Alex Oscar Caceres Velasco
    Nataly Nanda Huanca Patzi
    Luis Fernando Sejas Soliz
    Jose Luis Daza Sandi
    Franz Roberto Arratia Lopez
    Ronald Choque
    Juan Pablo Mejia
    Gonzalo Sarmiento
    Marcelo Aruzamen
    Eliana Lopez
    Adrian Grajeda
    Pablo Azero
    Deysi Iriarte