upstream/0.3.5/README

Gavare's eXperimental Emulator   --   GXemul 0.3.5
==================================================

Copyright (C) 2003-2005  Anders Gavare.


Overview
--------

GXemul is an experimental instruction-level machine emulator. It can be used to
run binary code for MIPS-based machines, regardless of host platform. Several
emulation modes are available. For some modes, processors and surrounding
hardware components are emulated well enough to let unmodified operating
systems (e.g. NetBSD) run as if they were running on a real machine.

(Non-MIPS emulation modes are also under development, but so far none of those
modes has reached the completeness required to run unmodified operating
systems.)


Quick start
-----------

To compile, type './configure' and then 'make'. This should work on most
Unix-like systems. If not, then please mail me a bug report.

If you are impatient, and want to try out running a guest operating system 
inside GXemul, please read this:  doc/guestoses.html#netbsdinstall

If you want to use GXemul for experimenting with code of your own, 
then I suggest you compile a Hello World program according to the tips 
listed here:  doc/experiments.html#hello

Please read the rest of the documentation in the doc/ sub-directory for
more detailed information on how to use the emulator.


Feedback
--------

If you have found GXemul useful in some way, or feel like sending me
comments or feedback in general, then mail me at anders(at)gavare.se.

1	dpavlin	12	Gavare's eXperimental Emulator -- GXemul 0.3.5
2	dpavlin	10	==================================================
3	dpavlin	2
4			Copyright (C) 2003-2005 Anders Gavare.
5
6
7			Overview
8			--------
9
10	dpavlin	12	GXemul is an experimental instruction-level machine emulator. It can be used to
11			run binary code for MIPS-based machines, regardless of host platform. Several
12			emulation modes are available. For some modes, processors and surrounding
13			hardware components are emulated well enough to let unmodified operating
14			systems (e.g. NetBSD) run as if they were running on a real machine.
15	dpavlin	2
16	dpavlin	12	(Non-MIPS emulation modes are also under development, but so far none of those
17			modes has reached the completeness required to run unmodified operating
18			systems.)
19	dpavlin	2
20	dpavlin	12
21	dpavlin	2	Quick start
22			-----------
23
24	dpavlin	4	To compile, type './configure' and then 'make'. This should work on most
25			Unix-like systems. If not, then please mail me a bug report.
26	dpavlin	2
27	dpavlin	10	If you are impatient, and want to try out running a guest operating system
28			inside GXemul, please read this: doc/guestoses.html#netbsdinstall
29	dpavlin	2
30	dpavlin	10	If you want to use GXemul for experimenting with code of your own,
31			then I suggest you compile a Hello World program according to the tips
32			listed here: doc/experiments.html#hello
33	dpavlin	2
34	dpavlin	10	Please read the rest of the documentation in the doc/ sub-directory for
35			more detailed information on how to use the emulator.
36
37
38	dpavlin	2	Feedback
39			--------
40
41			If you have found GXemul useful in some way, or feel like sending me
42			comments or feedback in general, then mail me at anders(at)gavare.se.
43