- Added support for NTLDR style freeloader GUI. To enable, edit freeldr.ini and add:
[reactos.git] / reactos / INSTALL
index 7da4170..2964e7f 100644 (file)
@@ -1,39 +1,78 @@
 1. Build environment
 
-To build the system you need either mingw32 installed on Windows or a
-mingw32 cross compiler running on unix.
+To build the system you need either mingw32 installed on Windows or a mingw32
+cross compiler running on unix. You may obtain MinGW binaries that build
+ReactOS from http://www.reactos.com. 
 
-2. Building
 
-To build from Windows run make. To build from unix, edit rules.mak and change 
-the PREFIX variable to the correct value for your cross-compiler, then run 
-'make'.
+2. Building ReactOS
+
+2.1 Building the binaries
+
+To build ReactOS run 'make' (wihout the quotes) if you are building on Linux
+or 'mingw32-make' if you are building on Windows (or ReactOS) from the top
+directory.
+
+
+2.2 Building a bootable CD image
+
+To build a bootable CD image run 'make bootcd' (wihout the quotes) if you are
+building on Linux or 'mingw32-make bootcd' if you are building on Windows (or
+ReactOS) from the top directory. This will create a CD image with a filename,
+ReactOS.iso, in the top directory.
+
 
 3. Installation
 
-Installation isn't yet automated, sorry. The system can only be installed on
-the first partition which must be formatted for DOS. Set up a directory
-structure like the following
+ReactOS can only be installed on a machine that has a FAT16 or FAT32 partition
+as the active (bootable) partition. The partition on which ReactOS is to be
+installed (which may or may not be the bootable partition) must also be
+formatted as FAT16 or FAT32. ReactOS Setup can format the partitions if
+needed.
+
+ReactOS can be installed from the source distribution or from the bootable CD
+distribution. The two ways to install ReactOS are explained below.
+
+
+3.1 Installation from sources
+
+If you don't have an existing ReactOS installation you want to upgrade, then
+build a bootable CD as described above. Burn the CD image, boot from it, and
+follow the instructions to install ReactOS.
+
+If you have an existing ReactOS installation you want to upgrade, then to
+install ReactOS after building it, type 'make install' or
+'mingw32-make install'. This will create the directory 'reactos' in the top
+directory. Copy the contents of this directory over the existing installation.
+
+If you don't want to copy the files manually every time you run a
+'make install' or 'mingw32-make install', then you can specify the directory
+where the files are to be copied to during installation.
+
+Set the ROS_INSTALL environment variable. If you are on Windows this could be
+done by:
+
+  set ROS_INSTALL=c:\reactos
+
+If you are on Linux this could be done by:
+
+  export ROS_INSTALL=/mnt/windows/reactos
+
+Now run 'make install' or 'mingw32-make install' to install the files to the
+new location.
+
+
+3.2 Installation from bootable CD distribution
 
-make directories C:\reactos,C:\reactos\system32,C:\reactos\system32\drivers
+To install ReactOS from the bootable CD distribution, extract the archive
+contents. Then burn the CD image, boot from it, and follow instructions.
 
-Copy apps/system/shell/shell.exe to C:\reactos\system32
-Copy subsys/smss/smss.exe to C:\reactos\system32
-Copy apps/system/winlogon/winlogon.exe to C:\reactos\system32
-Copy apps/system/services/services.exe to C:\reactos\system32
-Copy services/input/keyboard/keyboard.sys to C:\reactos\system32\drivers
-Copy services/dd/blue/blue.sys to C:\reactos\system32\drivers
-Copy lib/ntdll/ntdll.dll to C:\reactos\system32
-Copy lib/kernel32/kernel32.dll to C:\reactos\system32
-Copy lib/crtdll/crtdll.dll to C:\reactos\system32
 
-The system can only be started from DOS. Copy the following files,
-services/dd/ide/ide.sys, services/fs/vfat/vfatfsd.sys
-ntoskrnl/ntoskrnl.exe and loaders/dos/loadros.com, to a suitable
-directory, such as C:\. The system can then be booted with the
-command 'loadros.com ntoskrnl.exe ide.sys vfatfs.sys'.
+5. Help
 
+If you run into problems or have suggestions for making ReactOS better, please
+visit the address below and subscribe to one or more of the mailing lists.
 
-You may also want to try running the enhanced shell, cmd.exe, found in
-the rosapps CVS module.  For more information see the doc directory
+http://www.reactos.com/en/content/view/full/66
 
+ReactOS Development Team