commit 81b57ac43f234c46b019f8f17dd1077bb92e76e5
parent 1c3cfc4e477703130c39e2bdadaee71a7013cf99
Author: Brian Swetland <swetland@frotz.net>
Date: Fri, 3 Jan 2014 20:53:21 -0800
update top level readme
Diffstat:
| M | README | | | 20 | ++++++++++++++------ |
1 file changed, 14 insertions(+), 6 deletions(-)
diff --git a/README b/README
@@ -1,6 +1,7 @@
-This branch (master) consists of some small changes and rearrangements of
-the very cool xv6 project from: http://pdos.csail.mit.edu/6.828/2012/xv6.html
+This is a port of xv6 to the x86-64 platform (from i386), attempting to
+be as minimally intrusive as possible (beyond some initial reorganization
+of the source code layout and build system).
"xv6 is a re-implementation of Dennis Ritchie's and Ken Thompson's Unix
Version 6 (v6). xv6 loosely follows the structure and style of v6,
@@ -9,6 +10,9 @@ the very cool xv6 project from: http://pdos.csail.mit.edu/6.828/2012/xv6.html
The original upstream branch (mirror) was pulled from the git repository
git://pdos.csail.mit.edu/xv6/xv6.git
+The original project homepage is here:
+http://pdos.csail.mit.edu/6.828/2012/xv6.html
+
The PDF books about the rev7 version of xv6 are checked into the books branch
of this repository for easy access. They come from the xv6 project's home site.
@@ -19,8 +23,12 @@ while poking at their code.
. . .
-The biggest change to the code thus far is to organize it into kernel/,
-include/, user/, ulib/, and tools/ subdirectories, and arrange for the
-build to put intermediate object files into kobj/ and uobj/ directories,
-other intermediates into out/ and the filesystem contents into fs/.
+The code has been organized into kernel/, include/, user/, ulib/, and tools/
+subdirectories, and arranged so that the build puts intermediate object files
+into kobj/ and uobj/ directories, other intermediates into out/, and the
+filesystem contents into fs/.
+
+The Makefile defaults to building the 32bit version of xv6. Define the X64
+environment variable to build the 64bit version.
+README.64BIT contains notes about the 64bit port.
