cleanup

[wxWidgets.git] / docs / mac / install.txt

diff --git a/docs/mac/install.txt b/docs/mac/install.txt
index 3ce9533a50ad3394e9ee3ea5c81240d8f439ff84..2500039c836ac9b34e0cdae6d72b6509c36fef80 100644 (file)
--- a/docs/mac/install.txt
+++ b/docs/mac/install.txt
@@ -1,11 +1,11 @@
-Installing and compiling wxMac
-============================================================
+wxWidgets 2.5 for Mac installation
+----------------------------------

 
 On MacOS X, you can download Apple's free developer tools (gcc
 and associated headers and libraries, such as the Carbon API).
 You can then use configure in a similar way to compiling
 
 On MacOS X, you can download Apple's free developer tools (gcc
 and associated headers and libraries, such as the Carbon API).
 You can then use configure in a similar way to compiling

-wxWindows on Linux, (or on Windows using MinGW or Cygwin). See
-'Apple Developers Tools' below for more details on using
+wxWidgets on Linux (or on Windows using MinGW or Cygwin). See
+'Apple Developer Tools' below for more details on using

 configure.
 
 To target on MacOS 8 or 9, you need to buy Metrowerks
 configure.
 
 To target on MacOS 8 or 9, you need to buy Metrowerks


@@ -44,6 +44,15 @@ CodeWarrior Pro 5:Pre-Release:Carbon & MacOSX Development:Carbonized MSL and
 CodeWarrior Pro 5:Pre-Release:Carbon & MacOSX Development:Carbonized Runtimes 
 (consult the file CodeWarrior Pro 5:Pre-Release:Carbon & MacOSX Development:Carbon & MacOSX README)
 
 CodeWarrior Pro 5:Pre-Release:Carbon & MacOSX Development:Carbonized Runtimes 
 (consult the file CodeWarrior Pro 5:Pre-Release:Carbon & MacOSX Development:Carbon & MacOSX README)
 

+Patching headers: CodeWarrior 8.x
+---------------------------------
+
+If you run into trouble with WCHAR_MIN and WCHAR_MAX in ansi.h,
+apply the patch ansi.diff.
+
+You may also need to comment out the _T definition in
+ctype.h if you get multiple definition errors.
+

 setup.h
 -------
 
 setup.h
 -------
 


@@ -95,35 +104,55 @@ start of /wx/wx_cw_d.h (or similar filename).
 AppleScript Files
 -----------------
 
 AppleScript Files
 -----------------
 

-Several AppleScript files are provided in the docs:mac directory (currently
-only for CodeWarrior 5.3 related projects):
-  - M5xml2mcp.applescript to convert xml files to CodeWarrior projects
-  - M5mcp2xml.applescript to convert CodeWarrior projects to xml files
+Several AppleScript files are provided in the docs:mac directory:
+
+  - M5xml2mcp.applescript to convert xml files to CodeWarrior 5 projects
+  - M5mcp2xml.applescript to convert CodeWarrior 5 projects to xml files

   - M5build.applescript to automatically build all samples/demos projects
   - M5build.applescript to automatically build all samples/demos projects

+  - M8xml2mcp.applescript to convert xml files to CodeWarrior 8 projects
+  - M8mcp2xml.applescript to convert CodeWarrior 8 projects to xml files
+  - SetXMLCreator.applescript to set correct creator type (see below)
+
+To run the XML to MCP conversion scripts:

 
 

-Apple Developers Tools
-----------------------
+Double click on e.g. docs/mac/M8xml2mcp.applescript, then "run"
+the applescript and when asked for a folder pick src/. Then it
+takes a while to scan all dirs for the xml files and convert
+them to mcps. If some conversions fail it means an mcp already
+exists (back them up prior to running the script).

 
 

-As in all Unix projects, you need to do something like this under MacOS 10.1
-with the Apple Developers Tools installed:
+To set the correct creator type for importing into CodeWarrior,
+you may need to run SetXMLCreator.applescript.
+
+Apple Developer Tools
+---------------------
+
+As in all Unix projects, you need to do something like this under MacOS X
+with the Apple Developer Tools installed:

 
 1) cd into the base dir
 
 1) cd into the base dir

-2) mkdir build
-3) cd build
+2) mkdir osx-build
+3) cd osx-build

 4) ../configure
 5) make
 
 4) ../configure
 5) make
 

-If you want to install the library, you need to be able to log in as "root".
-For this, "root" has to be activated in the NetInfo utility - there you will
-also have to choose a password for the "root" user. Then
+If you want to install the library into the system directories you'll need
+to do this as root.  The accepted way of running commands as root is to
+use the built-in sudo mechanism.  First of all, you must be using an
+account marked as a "Computer Administrator".  Then

 
 

-6) su
-7) type <PASSWORD>
-8) make install
-9) exit
+6) sudo make install
+7) type <YOUR OWN PASSWORD>
+
+Note that while using this method is okay for development, it is not
+recommended that you require endusers to install wxWidgets into their
+system directories in order to use your program.  One way to avoid this
+is to configure wxWidgets with --disable-shared.  Another way to avoid
+it is to make a framework for wxWidgets.  Making frameworks is beyond
+the scope of this document.

 
 Note:
 
 Note:

-You might want to configure a static library instead:
+We recommend you configure a static library instead:

 
 4) ../configure --disable-shared
 
 
 4) ../configure --disable-shared
 


@@ -131,6 +160,10 @@ or activate OpenGL:
 
 4) ../configure --with-opengl
 
 
 4) ../configure --with-opengl
 

+Note:
+It is rarely desirable to install non-Apple software into system directories.
+By configuring the library with --disable-shared and using the full path
+to wx-config with the --in-place option you can avoid installing the library.

 
 Problems with .xpm files
 ------------------------
 
 Problems with .xpm files
 ------------------------