README.txt overview for the eSpeakPackage and MyroC software

The eSpeakPackage provides a C-callable interface for use in
programs. The package is particularly useful in testing programs
involve robot actions --- viewing of the source code is not needed.

  * Without the eSpeakPackage, testing a program controlling a robot
    requires a user to review the code while observing whether the
    robot performs the desired actions.

  * With the eSpeakPackage, a program can announce what it should be
    doing, and the user can focus on whether or not the robot behaves
    as desired.

The MyroC software provides a C-based library for interacting with
Scribbler 2 robots.
   * Scribbler 2 robots initially are paired with a local workstation
     * on Linux, the pairing is achieved as part of a call to the
       MyroC function rConnect.
     * on Mac OS X and Windows 10 computers, an initial pairing
       is completed through the Bluetooth manager for a local machine.
       Thereafter a call to the MyroC function rConnect initiates
       an active pairing
   * After a connection is made, the MyroC library provides functions
     for interacting with 1 or more robots.

The MyroC/eSpeakPackage material is licensed under a Creative Commons
Attribution-Non-Commercial-Share Alike 4.0 International License.

This package contains the following directories:

* README.txt:   a file with a high-level overview of the MyroC package

* License.txt:  a summary of the Creative Commons
                Attribution-Noncommercial-Share Alike 4.0 International License
                under which all MyroC software is distributed.

* eSpeak:       a directory of implementation-related files for the eSpeak
                package, version 3.0,  as well as 3 application
                programs for testing

* eSpeak-documentation:  a directory containing documentation for the
               eSpeak package, in html format

* MyroC.3.3a:  a directory of implementation-related files for the MyroC package, version 3.3a

* MyroC-documentation: documentation for the MyroC package, in both html and
               latex formats
               
* test-programs: several C programs to aid testing of the MyroC and
               eSpeakPadckage software

Full installation instructions are available through links from
   http://walker.cs.grinnell.edu/MyroC/

Created 1 March 2015 by Henry M. Walker
Revised 19 October 2015 by Henry M. Walker
Revised 4 January 2021 by Henry M.Walker

