Some updates to the documentation, particularly for the OSX stuff;

the name 'MacOSX' is now used more consistently.

Updated OSX build script and associated DMG template to create
release files in the form of 'Stella-VERSION-macosx.dmg'.


git-svn-id: svn://svn.code.sf.net/p/stella/code/trunk@2007 8b62c5a3-ac7e-4cc8-8f21-d9a121418aba

Announce.txt

@@ -14,10 +14,10 @@
 
 The Atari 2600 Video Computer System (VCS), introduced in 1977, was the
 most popular home video game system of the early 1980's.  Now you can enjoy
-all of your favorite Atari 2600 games on your PC thanks to Stella! 
+all of your favourite Atari 2600 games on your PC thanks to Stella! 
 
 Stella is a multi-platform Atari 2600 VCS emulator.  It allows you to play
-all of your favorite Atari 2600 games again!  Stella was originally
+all of your favourite Atari 2600 games again!  Stella was originally
 developed for Linux by Bradford W. Mott, however, it has been ported to a
 number of other platforms and is currently maintained by Stephen Anthony.
 
@@ -33,7 +33,7 @@ distributions currently available are:
 
   * Binary distribution for Mac OSX 32-bit & 64-bit :
       Stella-3.1-macosx.dmg (32-bit Universal Binary)
-      Stella-3.1-intel.macosx.dmg (32/64-bit Intel-only)
+      Stella-3.1_intel-macosx.dmg (32/64-bit Intel-only)
 
   * Binary distribution in 32-bit & 64-bit Ubuntu DEB format :
       stella_3.1-1_i386.deb

Todo.txt

@@ -12,10 +12,9 @@
                                 To Do List
 ===========================================================================
 
-If you would like to contribute to Stella's development then find something
-on the list below and send email to Bradford Mott at bwmott@acm.org or
-Stephen Anthony at stephena@users.sourceforge.net.
-
 All Todo items are now available in the Stella tracker on AtariAge:
 
   http://www.atariage.com/forums/tracker/project-16-stella-emulator
+
+If you would like to contribute to Stella's development then find something
+on the list above and email Stephen Anthony (stephena@users.sf.net).

docs/index.html

@@ -311,10 +311,10 @@
 	<p>The Mac version of Stella is designed to work on an Apple Macintosh with
 	the following:</p>
 	<ul>
-		<li>Mac OSX 10.4 (Tiger) or above</li>
+		<li>MacOSX 10.4 (Tiger) or above</li>
 		<li>PPC G4 or Intel processor, 500MHz or above</li>
 		<li>OpenGL capable video card; software rendering mode is still available,
-			but as of OSX 10.4 is substandard compared to OpenGL</li>
+			but as of MacOSX 10.4 is substandard compared to OpenGL</li>
 		<li>Xcode 3.2 is required to compile the Stella source code (SDL 1.2.14 also
 			required to compile the 64-bit version)</li>
 		<li>The 64-bit version requires at minimum Snow Leopard (10.6) and Intel CPU</li>
@@ -338,7 +338,7 @@
 	<h2><b>Other</b></h2>
 
 	<p>Stella is extremely portable, and in its lifetime has been ported to almost every
-	platform where the SDL library exists.  It is 32/64 bit clean in Linux/Unix, Mac OSX
+	platform where the SDL library exists.  It is 32/64 bit clean in Linux/Unix, MacOSX
 	and Windows.  The Stella Team is interested in hearing about any problems you may
 	encounter with diverse operating systems and CPU types.</p>
 
@@ -417,10 +417,9 @@
 	<p>
 	<h2><b>Macintosh</b></h2>
 	<ul>
-		<li><b>Binary DMG file</b> (StellaOSX<i>release</i>.dmg)
+		<li><b>Binary DMG file</b> (Stella-<i>release</i>-macosx.dmg)
 			<ol>
-				<li>Mount the disk image, then copy the Stella<i>release</i>macosx.dmg folder to
+				<li>Mount the disk image, then copy the Stella-<i>release</i>-macosx.dmg folder to	your hard drive</li>
-				your hard drive</li>
 			</ol>
 		</li>
 		<li><b>Compressed tarball : building from source code</b> (stella-<i>release</i>-src.tar.gz)
@@ -430,7 +429,7 @@
 				<li>Open the <b>stella-<i>release</i>/src/macosx/stella.xcodeproj</b>
 					file using Xcode 3.2</li>
 				<li>Make sure you have the SDL framework installed in src/macosx</li>
-				<li>Build the 'Stella' project</li>
+				<li>Build the 'Stella' project (making sure to select 'Deployment' mode)</li>
 				<li>For installation:
 				<ul>
 					<li>Run the script <b>Create_build.sh</b>, located in the src/macosx directory.
@@ -648,7 +647,7 @@
 		<tr>
 			<td><pre>-gl_lib &lt;filename&gt;</pre></td>
 			<td>OpenGL mode only. Specify the OpenGL library to use (only use
-				this if you know what you're doing).  For OSX, this should
+				this if you know what you're doing).  For MacOSX, this should
 				probably be left blank.</td>
 		</tr>
 
@@ -1348,7 +1347,7 @@
 		<tr>
 			<th>Function</th>
 			<th>Key (Standard)</th>
-			<th>Key (OSX)</th>
+			<th>Key (MacOSX)</th>
 		</tr>
 
 		<tr>
@@ -1952,7 +1951,7 @@
 		<tr>
 			<th>Function</th>
 			<th>Key (Standard)</th>
-			<th>Key (OSX)</th>
+			<th>Key (MacOSX)</th>
 		</tr>
 
 		<tr>
@@ -2100,7 +2099,7 @@
 		<tr>
 			<th>Function</th>
 			<th>Key (Standard)</th>
-			<th>Key (OSX)</th>
+			<th>Key (MacOSX)</th>
 		</tr>
 
 		<tr>
@@ -2496,8 +2495,8 @@
 
 	<p>Note that you must use the entire name of the port as specified by
 	your operating system.  For example, in Windows this would be COM1,
-	COM2, etc; Linux and OSX tend to use names similar to '/dev/xxxxxx'.
+	COM2, etc; Linux and MacOSX tend to use names similar to '/dev/xxxxxx'.
-	For now, only Linux/UNIX, OSX, and Win32 are supported.</p>
+	For now, only Linux/UNIX, MacOSX, and Win32 are supported.</p>
 
 	<p>Support for the EEPROM portion of the AtariVox and SaveKey is currently
 	emulated.  That is, a file will be created on your computer simulating the
@@ -3117,7 +3116,7 @@ Ms Pac-Man (Stella extended codes):
 			versions.  Added INI file support, faster startup, snapshot support,
 			and pause functionality to core.  Converted Stella 1.1 manual to HTML.
 			Ported codebase to SDL for Windows/MacOSX.  Added OpenGL support and
-			Stelladaptor support. Current maintainer for the Linux, OSX and Windows
+			Stelladaptor support. Current maintainer for the Linux, MacOSX and Windows
 			versions.</td>
 		</tr>
 
@@ -3401,7 +3400,7 @@ Ms Pac-Man (Stella extended codes):
 
 		<tr>
 			<td VALIGN="TOP">Albert&nbsp;Yarusso (aka Al from AtariAge)</td>
-			<td>Provided helpful feedback for the OSX port, and generously
+			<td>Provided helpful feedback for the MacOSX port, and generously
 				donated an AtariVox device to help with development</td>
 		</tr>
 

src/macosx/AboutBoxTextView.h

@@ -1,12 +1,30 @@
-/* AboutBoxTextView.h - Header for the
+//============================================================================
-   AboutBoxTextView view class for the
+//
-   Macintosh OS X SDL port of Stella
+//   SSSS    tt          lll  lll       
-   Mark Grebe <atarimac@cox.net>
+//  SS  SS   tt           ll   ll        
-*/
+//  SS     tttttt  eeee   ll   ll   aaaa 
-/* $Id$ */
+//   SSSS    tt   ee  ee  ll   ll      aa
+//      SS   tt   eeeeee  ll   ll   aaaaa  --  "An Atari 2600 VCS Emulator"
+//  SS  SS   tt   ee      ll   ll  aa  aa
+//   SSSS     ttt  eeeee llll llll  aaaaa
+//
+// Copyright (c) 1995-2010 by Bradford W. Mott, Stephen Anthony
+// and the Stella Team
+//
+// See the file "License.txt" for information on usage and redistribution of
+// this file, and for a DISCLAIMER OF ALL WARRANTIES.
+//
+// $Id$
+//============================================================================
 
 #import <Cocoa/Cocoa.h>
 
+/**
+  AboutBoxTextView class and support functions for the Macintosh OS X
+  SDL port of Stella.
+
+  @author  Mark Grebe <atarimac@cox.net>
+*/
 @interface AboutBoxTextView : NSTextView
 {
 }

src/macosx/AboutBoxTextView.m

@@ -1,9 +1,21 @@
-/* AboutBoxTextView.m - 
+//============================================================================
-   AboutBoxTextView view class for the
+//
-   Macintosh OS X SDL port of Stella
+//   SSSS    tt          lll  lll       
-   Mark Grebe <atarimac@cox.net>
+//  SS  SS   tt           ll   ll        
-*/
+//  SS     tttttt  eeee   ll   ll   aaaa 
-/* $Id: AboutBoxTextView.m,v 1.1.1.1 2004-06-16 02:30:30 markgrebe Exp $ */
+//   SSSS    tt   ee  ee  ll   ll      aa
+//      SS   tt   eeeeee  ll   ll   aaaaa  --  "An Atari 2600 VCS Emulator"
+//  SS  SS   tt   ee      ll   ll  aa  aa
+//   SSSS     ttt  eeeee llll llll  aaaaa
+//
+// Copyright (c) 1995-2010 by Bradford W. Mott, Stephen Anthony
+// and the Stella Team
+//
+// See the file "License.txt" for information on usage and redistribution of
+// this file, and for a DISCLAIMER OF ALL WARRANTIES.
+//
+// $Id$
+//============================================================================
 
 #import "AboutBoxTextView.h"
 #import "AboutBox.h"
@@ -15,12 +27,11 @@
 *-----------------------------------------------------------------------------*/
 - (void)mouseDown:(NSEvent *)theEvent
 {
-	if ([theEvent clickCount] >= 2)
+  if ([theEvent clickCount] >= 2)
-		[[AboutBox sharedInstance] doubleClicked];
+    [[AboutBox sharedInstance] doubleClicked];
-	else
+  else
-		[[AboutBox sharedInstance] clicked];
+    [[AboutBox sharedInstance] clicked];
-	[super mouseDown:theEvent];
+  [super mouseDown:theEvent];
 }
 
-
 @end

src/macosx/Create_build.sh

@@ -1,10 +1,10 @@
 #!/bin/sh
 #
-# Creates a StellaOSX disk image (dmg) from the command line.
+# Creates a Stella disk image (dmg) from the command line.
 # usage:
 #    Create_build.sh <version>
 #
-# The result will be a file called ~/Desktop/StellaOSX<ver>.dmg
+# The result will be a file called ~/Desktop/Stella-<ver>-macosx.dmg
 
 if [ $# != 1 ]; then
 	echo "usage: Create_build.sh version"
@@ -12,8 +12,8 @@ if [ $# != 1 ]; then
 fi
 
 VER="$1"
-DMG="StellaOSX${VER}.dmg"
+DMG="Stella-${VER}-macosx.dmg"
-DISK="/Volumes/StellaOSX"
+DISK="/Volumes/Stella"
 
 echo "Creating ${DMG} file ..."
 gunzip -c template.dmg.gz > ${DMG}

src/macosx/MenusEvents.h

@@ -1,13 +1,28 @@
-/* MenusEvents.h - Menus window 
+//============================================================================
-   class defines for event sending between Objective-C
+//
-   and C++
+//   SSSS    tt          lll  lll       
-   Macintosh OS X SDL port of Stella
+//  SS  SS   tt           ll   ll        
-   Mark Grebe <atarimac@cox.net>
+//  SS     tttttt  eeee   ll   ll   aaaa 
-   
+//   SSSS    tt   ee  ee  ll   ll      aa
+//      SS   tt   eeeeee  ll   ll   aaaaa  --  "An Atari 2600 VCS Emulator"
+//  SS  SS   tt   ee      ll   ll  aa  aa
+//   SSSS     ttt  eeeee llll llll  aaaaa
+//
+// Copyright (c) 1995-2010 by Bradford W. Mott, Stephen Anthony
+// and the Stella Team
+//
+// See the file "License.txt" for information on usage and redistribution of
+// this file, and for a DISCLAIMER OF ALL WARRANTIES.
+//
+// $Id$
+//============================================================================
+
+/**
+  Menus window class defines for event sending between Objective-C and C++
+  for the Macintosh OS X SDL port of Stella.
+
+  @author  Mark Grebe <atarimac@cox.net>
 */
-/* $Id$ */
- 
 #define MENU_OPEN               2
 #define MENU_VOLUME_INCREASE    3
 #define MENU_VOLUME_DECREASE    4
-

src/macosx/SDLMain.m

@@ -4,7 +4,7 @@
 
     Feel free to customize this file to suit your needs
 */
-/* $Id: SDLMain.m,v 1.6 2008-12-21 00:12:15 stephena Exp $ */
+/* $Id$ */
 
 #import "SDL.h"
 #import "SDLMain.h"