
# File: examples/readme
# Purpose: Readme file for examples directory
# Author: Phil Bunce (pjb@carmel.com)
# Revision History:
#	990115	Created

This directory contains a number of example programs. Most of the programs
can be built 5 different ways:

	1. pmon 	-- download and execute under PMON

All you need to do in order to build everything in this directory, is 
select the processor type eg. 4101, 4102 etc. For example,

	C> nmake 		-- Win9x/NT
	or
	% make 		-- UNIX

There are 3 catagories of programs in this directory:

Benchmarks
	acker.c    -- implements Ackerman's function
	dhry.c     -- Dhrystone 1.0
	dry1.c     -- Dhrystone 1.1
	fibo.c     -- implements the Fibonacci series
	hanoi.c    -- solves the Towers of Hanoi problem
	puzzle.c   -- implements the standard puzzle benchmark
	qsort.c    -- performs a quicksort
	queens.c   -- solves the 8 queens problem
	sieve.c    -- uses the sieve function to find prime numbers
	sort.c     -- performs a bubble sort
	whetd.c    -- double precision Whetstone
	whets.c    -- single precision Whetstone
	stanford.c -- the Stanford suite

PMON examples
	onintr.c   -- An example of installing an asm exception handler
	hanoi.c    -- An implementation of The Towers of Hanoi that uses 
	              text graphics
	clock.c	   -- A program that displays a clock using large digits

Misc examples
	irq.c      -- An example of installing a C exception handler
	ledflash.c -- A program that flashes the LEDs on the board
	timetst.c  -- An example of using the time() function
	hello.c    -- Hello World!
	game.c     -- A simple game that uses text input and output
	bubble.c   -- A bubble sort of a doubly-linked list
	tstapp.c   -- An application that tests most of the features of the
	              run-time library
	sinewave.c -- A program that draws sinewaves on the screen
	wiggle.c   -- A program that draws lissagous figures on the screen

Please note that some of these programs require floating-point, and so
they will only run correctly if the execution environment includes
floating-point support in hardware, or via software emulation.

In addition to floating-point, some of these programs will not even
link correctly unless you have transcendental libraries. For this reason
they have been omitted from the standard build list. Please see the file
files.mk for directions on how to add them to the build list.

Each of these programs can be built for a number of different 
environments. They use a .flg (flag) file to "remember" what
environment the current build is for. This makes it possible to avoid
a "make clean" unless the environment changes.

