Subject: README
To: None <port-sun3>
From: Adam Glass <glass>
List: port-sun3
Date: 03/11/1994 22:55:56
	NetBSD/Sun3 release				<$Revision: 1.1 $>
		by Adam Glass <glass@sun-lamp.cs.berkeley.edu>

This README describes the NetBSD/Sun3 release as it stands today.
This release consists of sup directions for getting the NetBSD kernel
sources including the Sun3 port, some bootstrapping software, some
really minimal documentation and copies of relevant third party
sources.

The eventual goal of NetBSD/Sun3 is to be able to install NetBSD on a
Sun3 without requiring any sun binaries at all.  A secondary goal is
to be able to run SunOS binaries.

The intent of this release is to provide enough infrastructure and
such that people can hack on the Sun3 port.  In particular, a lot of
driver work is known to be needed.  There are also parts of the port
that have not been completely exercised and may contain unforseen
bugs.  There is much to do, and unfortunately the available bandwidth
of the author has steadily decreased.

In order to get this port over the final hump, I am putting out this
known-to-be-less than perfect release.  It is my hope that others
will hack on this code, filling in the missing pieces so that we can
eventually release a fully functional NetBSD/Sun3.  Together I believe
we can make this port a reality.

This port was hosted under SunOS, i.e configed, and compiled.  It
should be possible to host it on another system as long as (currently)
the target architecture/os is SunOS, and you can get the necessary
tools compiled.

You'll need to get the sources for the NetBSD kernel, and some tools.
Directions for how to do this can be found in SUP.sun3 in this same
directory.

Getting some of these tools up under SunOS is a bit of a pain, so I've
included enough binaries that you can sidestep this problem for the
moment.  Getting the compilation environment setup is described in
"ENVIRONMENT"

A full description of how to build/test a NetBSD/sun3 kernel can be
found in "BUILDING".

A short port status (how far does it get this week?) and longer todo list can be found in TODO.  The port itself can be found in src/sys/arch/sun3.

I've also included relevant code from other sources (Sprite, Mach3)
that perhaps we can steal...

Bugs, Commments, etc. to port-sun3@sun-lamp.cs.berkeley.edu and not to
me personally.

Here is a tour of the tree:

README				this document
ENVIRONMENT			tells you how to setup an environment in
				which you can compile NetBSD/Sun3 kernels.
BUILDING	 		tells you how to build a NetBSD/sun3 kernel
				and how to test it.
STATUS				summary of port status
SUP				Instructions on how to use SUP
TODO				TODO list
other_srcs			stuff from sprite, and mach3 that is applicable
sun3_bin			some sun3 SunOS binaries included.
				Their use is described in ENVIRONMENT...
NetBSD-m68k			some NetBSD/m68k binaries.
				Their use is described in ENVIRONMENT as well.
docs				documentation on the autoconfig scheme used

In the actual sources:
src				NetBSD source tree (enough to build kernels)
src/sys/arch/sun3		NetBSD/sun3 port

Suggested reading order is:
	this README	
	STATUS
	SUP
	ENVIRONMENT
	BUILDING
	TODO
	src/sys/arch/sun3/*

------------------------------------------------------------------------------