README

   1 Bochs - The cross platform IA-32 (x86) emulator
   2 Updated: Tue Jun 3 18:11:00 CEST 2008
   3 Version: 2.3.7
   4
   5 WHAT IS BOCHS?
   6
   7 Bochs is a highly portable open source IA-32 (x86) PC emulator
   8 written in C++, that runs on most popular platforms.  It includes
   9 emulation of the Intel x86 CPU, common I/O devices, and a custom
  10 BIOS.  Currently, Bochs can be compiled to emulate a 386, 486,
  11 Pentium/PentiumII/PentiumIII/Pentium4 or x86-64 CPU, including optional
  12 MMX, SSEx and 3DNow! instructions.  Bochs is capable of running
  13 most Operating Systems inside the emulation, for example Linux, DOS,
  14 Windows 95/98/NT/2000/XP or Windows Vista.
  15 Bochs was written by Kevin Lawton and is currently maintained by
  16 the Bochs project at "http://bochs.sourceforge.net".
  17
  18 Bochs can be compiled and used in a variety of modes, some which are
  19 still in development.  The 'typical' use of bochs is to provide
  20 complete x86 PC emulation, including the x86 processor, hardware
  21 devices, and memory.  This allows you to run OS's and software within
  22 the emulator on your workstation, much like you have a machine
  23 inside of a machine.  Bochs will allow you to run Windows
  24 applications on a Solaris machine with X11, for example.
  25
  26 Bochs is distributed under the GNU LGPL.  See COPYING for details.
  27
  28 GETTING CURRENT SOURCE CODE
  29
  30 Source code for Bochs is available from the Bochs home page at
  31 http://bochs.sourceforge.net.  You can download the most recent
  32 release, use CVS to get the latest sources, or grab a CVS
  33 snapshot which is updated nightly.  The releases contain the most
  34 stable code, but if you want the very newest features try the
  35 CVS version instead.
  36
  37 WHERE ARE THE DOCS?
  38
  39 The Bochs documentation is written in Docbook.  Docbook is a text
  40 format that can be rendered to many popular browser formats such
  41 as HTML, PDF, and Postscript.  Each binary release contains the
  42 HTML rendering of the documentation.  Also, you can view the
  43 latest documentation on the web at
  44   http://bochs.sf.net/doc/docbook/index.html
  45
  46 Some information has not yet been transferred from the older
  47 HTML docs.  These can be found at http://bochs.sf.net/docs-html
  48
  49 WHERE CAN I GET MORE INFORMATION?  HOW DO I REPORT PROBLEMS?
  50
  51 Both the documentation and the Bochs website have instructions on how
  52 to join the bochs-developers mailing list, which is the primary
  53 forum for discussion of Bochs.  The main page of the website also
  54 has links to bug reports and feature requests.  You can browse and
  55 add to the content in these areas even if you do not have a (free)
  56 SourceForge account.  We need your feedback so that we know what
  57 parts of Bochs to improve.
  58
  59 There is a patches section on the web site too, if you have made
  60 some changes to Bochs that you want to share.
  61
  62 HOW CAN I HELP?
  63
  64 If you would like contribute to the Bochs project, a good first step
  65 is to join the bochs-developers mailing list, and read the archive
  66 of recent messages to see what's going on.
  67
  68 If you are a technical person (can follow hardware specs, can write
  69 C/C++) take a look at the list of open bug reports and feature
  70 requests to see if you are interested in working on any of the
  71 problems that are mentioned in them.  If you check out the CVS
  72 sources, make some changes, and create a patch, one of the
  73 developers will be very happy to apply it for you.  Developers who
  74 frequently submit patches, or who embark on major changes in the
  75 source can get write access to CVS.  Be sure to communicate with the
  76 bochs-developers list to avoid several people working on the same
  77 thing without realizing it.
  78
  79 If you are a Bochs user, not a hardware/C++ guru, there are still
  80 many ways you could help out.  For example:
  81   - write instructions on how to install a particular operating system
  82   - writing/cleaning up documentation
  83   - testing out Bochs on every imaginable operating system and
  84     reporting how it goes.