README

#################
# Ruby Programs #
#################

operator.rb
- Operates the Tabulator
- Prints help info when called without args
- Reads and writes the file TABULATOR_DATA.yml

lib/tabulator.rb
- The Tabulator

lib/validator.rb
- The Validator for Tabulator data sets

lib/syntax_checker.rb
- YAML Syntax Checker for TTV Common Data Format (CDF) datasets

test/operator_test.rb
- Ruby Unit Tests for the Tabulator Operator

test/tabulator_test.rb
- Ruby Unit Tests for the Tabulator

test/validator_test.rb
- Ruby Unit Tests for the Tabulator Validator

test/syntax_checker_test.rb
- Setup and Test the YAML Syntax Checker

test/emgr_data_handler.rb
- [DEBUG] Converts two real EMGR datasets into an Election Definition in
  preparation for syntax checking and validation by the Tabulator

###########################
# Ruby Unit Test Commands #
###########################

ruby -I . test/operator_test.rb
ruby -I . test/tabulator_test.rb
ruby -I . test/validator_test.rb
ruby -I . test/syntax_checker_test.rb

################
# Bash Scripts #
################

ERRS.sh
- prints out all the error/warning messages in the Tabulator code base
- checks to see if the validator test is in sync with the code

TEST.sh
- runs various tests, use "help" as an arg for a complete explanation

###############
# Directories #
###############

data/
- Docs/
  - miscellaneous documents
- Schemas/
  - schema files for all data structures processed by the Tabulator
- Tests/
  - test data files

doc/
- RDoc documentation

lib/
- primary Ruby executables

test/
- Ruby unit tests

-----------------
Author: Jeff Cook
Date: 19 Feb 2011