Bring CHANGES hopefully up to date
[nasm.git] / INSTALL
blob461137d57541ec10f8660ecd5f5459803c7680d2
1 1. Installing NASM from source (Unix, MacOS X, Windows/Cygwin,
2    Windows/MinGW)
3 2. Installing NASM from source (Windows/MS Visual C++)
4 3. Installing NASM from source (DOS-Windows-OS/2/OpenWatcom)
7 1. Installing NASM from source (Unix, MacOS X, Windows/Cygwin, Windows/MinGW)
8 =============================================================================
10 Installing NASM is pretty straightforward on Unix or Unix-like systems
11 with Perl and GNU tools installed, including MinGW for Windows with
12 MSYS installed.  Perl is optional for compiling unmodified sources
13 from a tarball, but is required to build from git or for most source
14 modifications.
16 If you checked out source from git you will need to run autoconf to
17 generate configure, otherwise you don't have to.
19 $ autoheader
20 $ autoconf
22 Then run configure to detect your platform settings and generate makefiles.
24 $ ./configure
26 You can get information about available configuration options by
27 running `./configure --help`.
29 If configure fails, please file a bug report with detailed platform
30 information at:
32     http://www.sf.net/projects/nasm/
34 If everything went okay, type
36 $ make
38 to build NASM, ndisasm and rdoff tools, or
40 $ make everything
42 to build the former plus the docs.
44 You can decrease the size of produces executables by stripping off
45 unnecessary information, to achieve this run
47 $ make strip
49 If you install to a system-wide location you might need to become
50 root:
52 $ su <enter root password>
54 then
56 $ make install
58 optionally followed by 
60 $ make install_rdf
62 Or you can 
64 $ make install_everything
66 to install everything =)
69 Thats it, enjoy!
72 2. Installing NASM from source (Windows/MS Visual C++)
73 ======================================================
75 The recommended compiler for NASM on Windows is MinGW
76 (http://www.mingw.org), but it is also possible to compile with
77 Microsoft Visual C++ (tested with Visual C++ 2005 Express Edition.)
79 To do so, start the "Visual C++ Command Shell", go to the directory
80 where the NASM source code was extracted, and run:
82 > nmake /f Mkfiles/msvc.mak
84 We recommend MinGW over Visual C++ 2005 as we have found it to be more
85 up to date with regards to C99 compliance, and we are increasingly
86 using C99 features in NASM.
89 3. Installing NASM from source (DOS-Windows-OS/2/OpenWatcom)
90 ============================================================
92 NASM has been reported to build correctly with OpenWatcom 1.7 on and
93 OS/2 platform.  The NASM developers have not tested this on any other
94 platforms.
96 A WMAKE make file is provided:
98 > wmake -f Mkfiles\openwcom.mak <platform>
100 ... where <platform> is "dos", "win32" or "os2".
102 NASM is known to NOT compile correctly using OpenWatcom 1.7.1 as a
103 cross compiler with a Linux host (OpenWatcom bug report 751.)