commit 613f39d285e7d5c617c34d646f443d428520a4cb
parent 092f2cbce7ae4b277fbc7f86e9eb0da272680bd2
Author: Brian Swetland <swetland@frotz.net>
Date: Sat, 28 Dec 2013 04:27:15 -0800
preserve original README and add a local branch README for clarity
Diffstat:
2 files changed, 13 insertions(+), 44 deletions(-)
diff --git a/README b/README
@@ -1,50 +1,19 @@
-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,
-but is implemented for a modern x86-based multiprocessor using ANSI C.
-ACKNOWLEDGMENTS
+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
-xv6 is inspired by John Lions's Commentary on UNIX 6th Edition (Peer
-to Peer Communications; ISBN: 1-57398-013-7; 1st edition (June 14,
-2000)). See also http://pdos.csail.mit.edu/6.828/2012/v6.html, which
-provides pointers to on-line resources for v6.
+ "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,
+ but is implemented for a modern x86-based multiprocessor using ANSI C."
-xv6 borrows code from the following sources:
- JOS (asm.h, elf.h, mmu.h, bootasm.S, ide.c, console.c, and others)
- Plan 9 (entryother.S, mp.h, mp.c, lapic.c)
- FreeBSD (ioapic.c)
- NetBSD (console.c)
+The original upstream branch (mirror) was pulled from the git repository
+git://pdos.csail.mit.edu/xv6/xv6.git
-The following people have made contributions:
- Russ Cox (context switching, locking)
- Cliff Frey (MP)
- Xiao Yu (MP)
- Nickolai Zeldovich
- Austin Clements
+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.
-In addition, we are grateful for the patches contributed by Greg
-Price, Yandong Mao, and Hitoshi Mitake.
+The original README remains as README.orig -- renamed to avoid misrepresenting
+this working branch and any local changes as the original project and to
+hopefully avoid people pestering the original authors about bugs I may introduce
+while poking at their code.
-The code in the files that constitute xv6 is
-Copyright 2006-2012 Frans Kaashoek, Robert Morris, and Russ Cox.
-
-ERROR REPORTS
-
-If you spot errors or have suggestions for improvement, please send
-email to Frans Kaashoek and Robert Morris (kaashoek,rtm@csail.mit.edu).
-
-BUILDING AND RUNNING XV6
-
-To build xv6 on an x86 ELF machine (like Linux or FreeBSD), run "make".
-On non-x86 or non-ELF machines (like OS X, even on x86), you will
-need to install a cross-compiler gcc suite capable of producing x86 ELF
-binaries. See http://pdos.csail.mit.edu/6.828/2012/tools.html.
-Then run "make TOOLPREFIX=i386-jos-elf-".
-
-To run xv6, you can use the Bochs or QEMU PC simulators. Bochs makes
-debugging easier, but QEMU is much faster. To run in Bochs, run "make
-bochs" and then type "c" at the bochs prompt. To run in QEMU, run
-"make qemu".
-
-To create a typeset version of the code, run "make xv6.pdf". This
-requires the "mpage" utility. See http://www.mesa.nl/pub/mpage/.
diff --git a/README b/README.orig
