Changes between Version 15 and Version 16 of Build instructions

Timestamp:

Dec 2, 2006 8:03:58 AM (17 years ago)

Author:

jose

Comment:

--

Build instructions

@@ -11 +11 @@
 == Linux hosts ==
 
-We at InnoTek mostly use [http://www.gentoo.org Gentoo], so the following build instructions apply to that environment. Things should not be much different for other distributions though. If you want to supply build instructions (especially package names) for other distributions, please contact InnoTek.
+While we try to not favor any distribution, we only build with certain distributions. This includes Debian, Ubuntu, Gentoo and Red Hat Enterprise Linux. Things should not be much different for other distributions though. If you want to supply specific build instructions (especially package names) for other distributions, please contact InnoTek.
 
 === Prerequisites on Linux ===
@@ -17 +17 @@
 You need: 
 
- * GCC 3.2.3 or later (when using GCC 4.x, some precompiled objects will be used for the recompiler as they require GCC 3.x)
+ * GCC 3.2.3 or later (when using GCC 4.x, some precompiled objects will be used for the recompiler as they currently require GCC 3.x)
  * as86 (real mode assembler)
  * bcc (Bruce Evans C Compiler)
@@ -26 +26 @@
  * Qt 3.3.x (with x >= 5 if possible)
  * libIDL
- * Relatively recent WINE (!VirtualBox uses some Win32 executables during the build process)
- * Java (http://java.sun.com/j2se/1.5.0/download.jsp)
+ * Relatively recent WINE (!VirtualBox uses some Win32 executables during the build process but this is optional)
  * libSDL (with sdl-ttf)
  * Optional: Doxygen 1.4+
@@ -43 +42 @@
 === Building on Linux ===
 
- 1. Change to the root directory of the sources and enter our build shell environment: `tools/env.sh`.
+ 1. Change to the root directory of the sources and execute the configure script: `./configure`. If it finds everything it needs, it will create a file called 'Config.kmkconf' containing paths to the various tools on your system. Also, it will create an environment setup script called `configure.sh`.  This step only has to be done once (if something changes in your build tool setup, you might have to repeat it but keep in mind that both output files will be overwritten).
 
- 2. To build a release package, type `kmk BUILD_TYPE=release all packing`. This produces the installation package `out/linux/release/bin/VirtualBox.run`. 
+ 2. Whenever you want to build !VirtualBox, you have to open a shell and source the generated environment setup script 'configure.sh', i.e. do
+{{{
+. ./configure.sh
+}}}
 
- 3. To install this package on your system, run it (as the superuser). So, for example, `cd out/linux/release/bin` and `sudo sh VirtualBox.run install`.
+ 3. To build a release package, type `kmk all packing`. This produces the installation package `out/linux/release/bin/VirtualBox.run`. (If you want to build a debug version, type `kmk BUILD_TYPE=debug all packing`.)
+
+ 4. To install this package on your system, run it (as the superuser). So, for example, `cd out/linux/release/bin` and `sudo sh VirtualBox.run install`.
 
 === Running your installed build on Linux ===
 
-The command sequence outlined above installs !VirtualBox in `/opt/VirtualBox-<version>` and the Linux kernel module in `lib/modules`. A shell script wrapper is put in `/usr/bin/VirtualBox`, so you should be able to run `VirtualBox` from everywhere. You will need to load the Linux kernel module before running `VirtualBox`, so a `modprobe vboxdrv` will also be necessary.
+The command sequence outlined above installs !VirtualBox in `/opt/VirtualBox-<version>` and the Linux kernel module in `lib/modules`. A shell script wrapper called `VBox.sh` will be installed and symlinked to from `/usr/bin/VirtualBox` (and other symlinks), so you should be able to run `VirtualBox` from everywhere. You will need to load the Linux kernel module before running `VirtualBox`, so a `modprobe vboxdrv` will also be necessary.
 
 == Windows hosts ==
@@ -61 +65 @@
  * DirectX SDK (http://www.microsoft.com/downloads/details.aspx?familyid=C72D9F1E-53F3-4747-8490-6801D8E8B4EF&displaylang=en)
  * MingW GCC v3.3.x or v3.4.x with matching binutils, runtime, and w32api (http://www.mingw.org/download.shtml).
- * Java (http://java.sun.com/j2se/1.5.0/download.jsp), runtime is sufficient (is this actually required for OSE?)
+To create the installation package:
  * .NET, version 2.0 recommended
+ * Microsoft Windows Installer XML (WiX) toolkit: http://sourceforge.net/projects/wix/
+ * Microsoft Driver Installation Framework Tools (DIFx): http://www.microsoft.com/whdc/driver/install/DIFxtls.mspx
 
 === Building on Windows ===