README

   1 xv6 is a re-implementation of Dennis Ritchie's and Ken Thompson's Unix
   2 Version 6 (v6).  xv6 loosely follows the structure and style of v6,
   3 but is implemented for a modern x86-based multiprocessor using ANSI C.
   4
   5 ACKNOWLEDGMENTS
   6
   7 xv6 is inspired by John Lions's Commentary on UNIX 6th Edition (Peer
   8 to Peer Communications; ISBN: 1-57398-013-7; 1st edition (June 14,
   9 2000)). See also http://pdos.csail.mit.edu/6.828/2007/v6.html, which
  10 provides pointers to on-line resources for v6.
  11
  12 xv6 borrows code from the following sources:
  13     JOS (asm.h, elf.h, mmu.h, bootasm.S, ide.c, console.c, and others)
  14     Plan 9 (bootother.S, mp.h, mp.c, lapic.c)
  15     FreeBSD (ioapic.c)
  16     NetBSD (console.c)
  17
  18 The following people made contributions:
  19     Russ Cox (context switching, locking)
  20     Cliff Frey (MP)
  21     Xiao Yu (MP)
  22     Nickolai Zeldovich
  23     Austin Clements
  24
  25 In addition, we are grateful for the patches contributed by Greg
  26 Price, Yandong Mao, and Hitoshi Mitake.
  27
  28 The code in the files that constitute xv6 is
  29 Copyright 2006-2007 Frans Kaashoek, Robert Morris, and Russ Cox.
  30
  31 ERROR REPORTS
  32
  33 If you spot errors or have suggestions for improvement, please send
  34 email to Frans Kaashoek and Robert Morris (kaashoek,rtm@csail.mit.edu).
  35
  36 BUILDING AND RUNNING XV6
  37
  38 To build xv6 on an x86 ELF machine (like Linux or FreeBSD), run "make".
  39 On non-x86 or non-ELF machines (like OS X, even on x86), you will
  40 need to install a cross-compiler gcc suite capable of producing x86 ELF
  41 binaries.  See http://pdos.csail.mit.edu/6.828/2007/tools.html.
  42 Then run "make TOOLPREFIX=i386-jos-elf-".
  43
  44 To run xv6, you can use Bochs or QEMU, both PC simulators.
  45 Bochs makes debugging easier, but QEMU is much faster.
  46 To run in Bochs, run "make bochs" and then type "c" at the bochs prompt.
  47 To run in QEMU, run "make qemu".
  48
  49 To create a typeset version of the code, run "make xv6.pdf".  This
  50 requires the "mpage" utility.  See http://www.mesa.nl/pub/mpage/.