This commit was generated by cvs2svn to compensate for changes in r145,
[chise/xemacs-chise.git.1] / nt / README
index 9dfe3f5..a6e5c95 100644 (file)
--- a/nt/README
+++ b/nt/README
@@ -10,53 +10,98 @@ from http://www.cs.washington.edu/homes/voelker/ntemacs.html
 
 To get it working you will need:
 
-1.  You will need Visual C++ V4.2 or later to compile everything. Personally we
-    have tested V4.2 and V5.0.
+1.  You will need Visual C++ V4.0 or later to compile everything. Personally we
+    have tested V4.0, V4.2 and V5.0.
     Note that Visual C++ assumes a couple of environment variables INCLUDE and
     LIB to be set which specify the location of the includes and libraries.
-    At this point you can select X or Win32 native support.
+    Your PATH environment variable also needs to include the DevStudio vc\bin
+    and sharedide\bin directories.
+    Visual C++ V5.0 installs a batch file called vcvars32.bat in
+    c:\Program Files\DevStudio\VC\bin\ (or wherever you installed it) that you
+    can run before building to set up all of these environment variables.
 
 2.  Grab the latest XEmacs source from ftp.xemacs.org if necessary. All Win32
     support is in the nt\ subdirectory. You'll also need the xemacs-base
     package from the binary-packages subdirectory and you'll probably also
-    want at least the edit-utils, text-utils, cc-mode and prog-utils packages.
-    Unpack the packages into, say, "c:\Program Files\XEmacs\packages".
+    want at least the edit-utils, text-modes, fsf-compat, cc-mode,
+    prog-modes and xemacs-devel packages.
+    Unpack the packages into, say, "c:\Program Files\XEmacs\xemacs-packages".
 
+3.  At this point you can select X or Win32 native GUI support.
 
 If you want to build for native GUI:
 
-1.  If you want XPM and toolbar support grab the latest version of the xpm
-    sources (xpm-3.4k.tar.gz at time of writing) and unpack them somewhere.
+1.  If you want XPM image and toolbar support grab the latest version of the
+    xpm sources (xpm-3.4k.tar.gz at time of writing) and unpack them somewhere.
     Copy nt\xpm.mak from the xemacs sources to the lib subdirectory of the
-    xpm sources, cd to that directory and build xpm with `nmake -f xpm.mak`.
+    xpm sources, cd to that directory and build xpm with 'nmake -f xpm.mak'.
 
-2.  cd to the nt subdirectory of the xemacs distribution and build xemacs:
+2.  You probably also want PNG image support. Grab the latest versions of zlib
+    and libpng (zlib-1.1.3 and libpng-1.0.2 at time of writing), unpack them
+    somewhere and read the respective READMEs for details on how to build them.
+    The following build procedure works for zlib-1.1.3 and libpng-1.0.2:
+
+    cd to the zlib directory, type 'copy msdos\makefile.w32 Makefile' and
+    then type 'nmake'.
+
+    cd to the libpng directory, rename or move the zlib directory to ..\zlib
+    and type 'nmake -f scripts\makefile.w32'.
+
+3.  If you want TIFF support, grap the latest version of libtiff (tiff-v3.4
+    at time of writing) and unpack it somewhere. Copy nt\tiff.mak from the 
+    xemacs sources to the contrib\winnt subdirectory of the tiff sources, 
+    cd to that directory and build libtiff with 'nmake -f tiff.mak'. Note:
+    tiff.mak has only been verified to work under WinNT, not Win95 or 98. 
+    However, the lastest distribution of libtiff includes a 
+    contrib\win95\makefile.w95; that might work.
+
+4.  If you want JPEG support grab the latest version of jpegsrc (jpeg-6b at 
+    time of writing) and read the README for details on how to build it.
+
+5.  If you want X-Face support, grab compface distribution and unpack it 
+    somewhere.  Copy nt\compface.mak from xemacs sources to the compface
+    directory.  cd to that directory and build libcompface with 
+    'nmake -f compface.mak'.
+
+6.  cd to the nt subdirectory of the xemacs distribution and build xemacs:
     `nmake install -f xemacs.mak`, but read on before hitting Enter.
 
-3.  If you're building with XPM support, add this to the nmake command line:
-       HAVE_XPM=1 XPM_DIR="x:\location\of\your\xpm\source\tree"
+7.  If you're building with XPM support, add this to the nmake command line:
+       HAVE_XPM=1 XPM_DIR="x:\location\of\your\xpm\sources"
+    and similarly for JPEG and TIFF support.
+
+    If you're building with PNG support, add this to the nmake command line:
+       HAVE_PNG=1 PNG_DIR="x:\location\of\your\png\sources"
+       ZLIB_DIR="x:\location\of\your\zlib\sources"
+
+    If you want to build with GIF support, add this to the nmake command line:
+       HAVE_GIF=1
+
+    If you're building with X-Face support, add this to the nmake command line:
+    HAVE_XFACE=1 COMPFACE_DIR="x:\location\of\your\compface\sources"
+
+8.  By default, XEmacs will expect to find its packages in the subdirectories
+    "site-packages", "mule-packages" and "xemacs-packages" under the package
+    prefix directory "c:\Program Files\XEmacs". If you want it to look for
+    these subdirectories elsewhere, add this to the nmake command line:
+       PACKAGE_PREFIX="x:\your\package\directory"
+    If you change your mind and want to alter the package prefix directory
+    after you've built XEmacs, delete the file .\obj\emacs.obj and rebuild with
+    the new PACKAGE_PREFIX.
 
-4.  By default, XEmacs will look for packages in
-    "c:\Program Files\XEmacs\packages". If you want it to look elsewhere,
+9.  By default, XEmacs will be installed in directories under the directory
+    "c:\Program Files\XEmacs\XEmacs-21.0". If you want to install it elsewhere,
     add this to the nmake command line:
-       PACKAGEPATH="x:\\location\\of\\your\\packages"
-    Note the doubled-up backslashes in that path. If you want to change the
-    package path after you've already built XEmacs, delete the file
-    .\obj\emacs.obj and rebuild with the new value of PACKAGEPATH.
-
-5.  By default, XEmacs will be installed in directories under the directory
-    "c:\Program Files\XEmacs\XEmacs-21.0". If you want to install it
-    elsewhere, add this to the nmake command line:
        INSTALL_DIR="x:\your\installation\directory"
 
-6.  Now you can press Enter. nmake will build temacs, the DOC file, update the
+10. Now you can press Enter. nmake will build temacs, the DOC file, update the
     elc's, dump xemacs and install the relevant files in the directories under
-    the installation directory. Unless you set INSTALL_DIR in step 5 above, the
-    file that you should run to start XEmacs will be installed as
+    the installation directory. Unless you set INSTALL_DIR above, the file that
+    you should run to start XEmacs will be installed as 
     "c:\Program Files\XEmacs\XEmacs-21.0\i386-pc-win32\runemacs.exe". You may
     want to create a shortcut to that file from your Desktop or Start Menu.
 
-7.  The build process always creates debugging and "Source Browser" information
+11. The build process always creates debugging and "Source Browser" information
     in the source tree for use with MS DevStudio. If you actually want to debug
     XEmacs you should run XEmacs from the source directory instead of from the
     installation directory. You should probably also build a debug version of