kbrow1i / toddcox Goto Github PK

Copyright 2011, 2012 Kenneth S. Brown.
See the end of the file for license conditions.

If you have obtained a prebuilt executable for your system, you can
skip the first item and proceed directly to "Running the program".

* Building Toddcox

See the `INSTALL' file in the source distribution for instructions.
After following the instructions, you should have an executable
program called `toddcox' possibly with `.exe' appended, either in your
current directory or somewhere in your path.

* Running the program

Type 'toddcox' at a command prompt.  Depending on how your path is set
up, you may have to include a path specification.  On a typical
Unix-like system, for example, you would type

  ./toddcox

if the `toddcox' program is contained in your current directory but
not in your path.

The program will prompt you to enter the necessary information.  The
documentation (see below) gives several examples.

* Running from a script

Instead of responding to all the prompts interactively, you can enter
them into a file and give the filename as a command-line argument.
The Toddcox source distribution contains several sample input files in
the `examples' directory.  Those files have been installed on your
system (in /usr/local/share/toddcox/examples by default) if you are
working on a Unix-like system and have run `make install' after
building Toddcox.  See the README file in that directory for a
description of the examples.

To run toddcox on the M12 example, for instance, issue the following
command:

  ./toddcox examples/M12.in

This assumes that your current directory is the top-level directory of
the Toddcox source distribution and that the `toddcox' executable is
in that directory.  Alternatively, if you have installed Toddcox on
your Unix-like system, the command might be

  toddcox /usr/local/share/toddcox/examples/M12.in

* Documentation

Documentation for Toddcox, including some sample runs of the program,
can be found in the `html' subdirectory of the source distribution.
This will be installed in your system documentation directory
(/usr/local/share/doc/toddcox by default) if you are working on a
Unix-like system and have run `make install' after building Toddcox.

* Questions, comments, and bug reports

The project website is

  <http://www.math.cornell.edu/~kbrown/toddcox/>

Questions, comments and bug reports should be sent to

  Ken Brown <[email protected]>


This file is part of Toddcox.

Toddcox 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 3 of the License, or (at your
option) any later version (GPLv3+).

Toddcox 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 Toddcox.  If not, see <http://www.gnu.org/licenses/>.


Local variables:
mode: outline
paragraph-separate: "[ 	]*$"
end: