# ===========================================================================
# $Id: readme51.txt,v 1.2 1997/07/22 14:47:13 gianpi Exp $
#
# Description:
#	uC/OS-51 - README File
#
# Author[s]:
#	Gianpaolo Macario   http://www.geocities.com/SiliconValley/Pines/5004
# ===========================================================================

INTRODUCTION

This archive file contains a porting of the uC/OS to the 8051 architecture.

The code in this archive is covered with the GNU Programming License;
see file COPYING which is enclosed in the archive.

Since Mr. Jean Labrosse, the original uC/OS author, did not release
the latest version of uC/OS to the public domain (or even GNU),
I am enclosing here only the differences to his own release,
which is available by purchasing his book "uC/OS - The Real Time Kernel".
In any case, I strongly recommend bying this book - it is a source
of useful information about uC/OS and nearly indispensable to anyone
wishing to use uC/OS and uC/OS-51.

For further help and information about uC/OS and uC/OS-51 read ucos51.htm.


WHAT YOU NEED

1. The diskette supplied with the book "uC/OS - The Real-Time Kernel".

2. The latest release of uC/OS-51.
   The file is named ucos51-<version>-<release>.zip,
   where <version> is the uC/OS version to work with,
   and <release> identifies the public snapshots of uC/OS-51
   with respect to the common uC/OS version.

3. PKUNZIP 2.04G or later. Info-ZIP will do the same thing, but it is free.

4. GNU Patch (optional).


WHAT YOU FIND IN UCOS51-*.ZIP

- ucos51a.asm ucos51c.c, ucos51c.h
  These are the target-dependent code.

- isr51.h
  This file contain the prototypes of setvect() and getvect(),
  whose implementation is in ucos51a.asm

- includes.h, os_cfg.h
  These files have the same meaning as Labrosse's ones.

- ucos51.htm
  This is a HTML file describing uC/OS-51 functions.
  Sorry but it is a bit dated right now (it refers to the public-domain
  V1.0 uC/OS code).

- ucos51.dif
  This is a difference file used by patch to modify ucos.c, ucos.h
  taken from Labrosse distribution.

- ex51l.c
  This is a small example code.

- makefile
  Makefile for BSO-Tasking MK51 showing how to use uC/OS-51 in your code.

- copying
  This is the GNU Programming License (you already knew it - didn't you?)  


INSTALLATION OF uC/OS-51

1. Install the diskette supplied with the book to the hard disk,
   using the command
	
	A:INSTALL C:

   (or any other drives)

2. Change to the directory containing uC/OS sources

	C:
	CD C:\SOFTWARE\UCOS

4. Unpack ucos51-*.zip to the current directory.

	pkunzip -d a:\ucos51*.zip

5. Copy target-independent sources to main uC/OS directory.

	COPY SOURCE\UCOS.* .

6. If you have GNU Patch available, execute

 	patch < ucos51.dif

   Otherwise, read ucos51.dif and try to figure out which lines to change
   in ucos.c and ucos.h.
   Obviously, I heartly recommend using GNU Patch!


WHERE TO REPORT BUGS AND SUGGEST IMPROVEMENTS TO uC/OS-51

Please visit my home page on Geocities:

http://www.geocities.com/SiliconValley/Pines/5004

Thank you for evaluating uC/OS-51!

Gianpaolo Macario
http://www.geocities.com/SiliconValley/Pines/5004

# === End of File ===