I updated the README file slightly, below is a patch.
Another few questions I've thought of:
- How's the logo migration coming along ?
- We should stick the plex86 logo on top of all publications in the
docs/ tree
- Do we have a plex86 freshmeat entry now ?
- Would it be possible to switch to a plex86@ mailinglist,
- ... and get a decent list archive ?
-- Ramon
diff -Nur plex86-old/README plex86/README
--- plex86-old/README Sun Apr 9 12:23:07 2000
+++ plex86/README Sun Apr 9 12:48:10 2000
@@ -1,20 +1,31 @@
-This is the beginnings to the virtualization framework that
-is needed for plex86.
+PLEX86 --- an x86 virtual machine
+=================================
+Welcome to plex86, the open-source x86 virtual machine. This document
+will get you started with running/testing plex86. For more detailed
+information, please consult the docs/ tree.
+
+plex86 is distributed under the Lesser General Public License (LGPL).
+Please check out the file COPYING in this directory for more details.
+
+A list of all code contributors to plex86 can be found in the file
+CONTRIBUTORS in this directory. You can find all changes in each release
+in the ChangeLog file.
+
+
+,-----------------------------------------------------------------.
+| IMPORTANT NOTICE |
+|-----------------------------------------------------------------|
+| This code is EXTREMELY EXPERIMENTAL, and may well result in a |
+| SYSTEM CRASH, and who knows what other ill effects. RUN THIS |
+| SOFTWARE AT YOUR OWN RISK. As a precaution, do not attempt to |
+| run this software on a system with important data on it, and |
+| make liberal use of the sync command! Expect to have to use |
+| the power button. |
+`-----------------------------------------------------------------'
-,------------------.
-| IMPORTANT NOTICE |
-|---------------------------------------------------------.
-| This code is EXTREMELY EXPERIMENTAL, and will likely |
-| result in a SYSTEM CRASH, and who knows what other |
-| ill effects. RUN THIS SOFTWARE AT YOUR OWN RISK. |
-| As a precaution, don't run it on a system with any |
-| important data on it, and make liberal use of the |
-| sync command! Expect to have to use the power button. |
-`---------------------------------------------------------'
-
-The directory tree is structured as follows:
+The plex86 directory tree is structured as follows:
plex86 root directory for plex86
|
@@ -29,31 +40,36 @@
| |
| `--- plugins contains the sources for the plugins
| |
+ | |--- bios BIOS plugin; loads executable and init VGA
| |--- ice ICE plugin; for using remote GDB
| `--- bochs BOCHS plugin; contains emulated
| hardware devices, and GUI code
|
- `--- guest contains several simple kernels for
- | testing VM functionality as it is added
+ |--- guest contains several simple kernels for
+ | | testing VM functionality as it is added
+ | |
+ | |--- virtcode simple non-multitasking kernel (shell)
+ | |--- cooperative simple cooperative multitasking kernel
+ | |--- preemptive simple preemptive multitasking kernel
+ | |--- paging same as preemptive, but with paging
+ | `--- test small testkernel for scan-before-execute
+ |
+ |
+ |--- misc contains miscellaneous files
+ |
+ |
+ `--- docs contains plex86 documentation
|
- |--- virtcode simple non-multitasking kernel (shell)
- |--- cooperative simple cooperative multitasking kernel
- `--- preemptive simple preemptive multitasking kernel
+ |--- sgml documentation sources in SGML format
+ |--- html documentation sources in HTML format
+ |--- txt documentation sources in plain text
+ `--- output the compiled versions of the docs
Things have been kept modularized regarding the host OS.
Anything OS specific should be put in "kernel/host-xyz.c"
or "kernel/include/host-xyz.h".
-Each time the host switches to the monitor/guest
-environment and runs that context. Normally, execution
-will continue in that context until a hardware interrupt
-occurs or other exception. The monitor interrupt handler
-switches back to the host context to handle the interrupt.
-The monitor/guest context will not resume execution until
-the next ioctl() call from the user program.
-
-
Directions for installation:
1. Enter the plex86 root directory and type ./configure.
@@ -88,9 +104,10 @@
5. If you do not have the VGA font installed, you will need
to install it first (you can check this by skipping to
- point 7, and checking whether it gives an error message).
- You will only have to do this once. The VGA font resides in
- misc/vga.pcf. In order to install it, you'll need to be root:
+ step 6, and checking whether running the VM gives an error
+ message). You will only have to do this once. The VGA font
+ resides in misc/vga.pcf. In order to install it, you'll need
+ to be root:
user> su
root> cp misc/vga.pcf X-font-path/misc
@@ -115,6 +132,6 @@
root> <...>/plex86/misc/unload_module.sh
-Let us know whether it works for you !!! The address of the
-plex86 mailing list is [EMAIL PROTECTED] Have a look
-on http://www.plex86.org/ for details.
+Let us know whether plex86 works for you !!! The address of the
+plex86 mailing list is [EMAIL PROTECTED] Have a look at the
+webpage http://www.plex86.org/ for details.
diff -Nur plex86-old/docs/output/README plex86/docs/output/README
--- plex86-old/docs/output/README Thu Jan 1 01:00:00 1970
+++ plex86/docs/output/README Sun Apr 9 13:18:57 2000
@@ -0,0 +1 @@
+This directory is generated dynamically - do not alter.
