initial version of Mac OS X README file (dirkpitt)

ver1_5_1
Hank Ramsey 2005-01-20 07:31:39 +00:00
parent 00704755ba
commit 60e29b95a1
1 changed files with 96 additions and 0 deletions

View File

@ -0,0 +1,96 @@
INTRODUCTION
This README file accompanies the initial release of Celestia 1.4.0pre6 for Mac OS X. It includes installation instructions and other helpful information.
Celestia is a cross-platform program. Versions are currently available for Windows and various flavors of Unix as well as MacOS X. Additional information which applies generally to all versions of the program will be found in the the following files that should be distributed along with this file: AUTHORS, ChangeLog, COPYING, README.
WARNING
This version is being made available on an "as is" basis. It does not include any Mac-specific bug fixes or enhancements (the only improvements are in the Celestia core code common to all platforms). It has not been extensively tested. You may have problems (see BUGS below). Report new bugs on the Celestia Forums (see SUPPORT below). New versions of the program will be announced there when they become available.
SYSTEM REQUIREMENTS
You will probably need at least Mac OS X 10.2 (Jaguar), but it is well-advised to have the latest version of the OS, particularly with respect to OpenGL improvements. Realize that Celestia makes intensive use of 3D graphics, and less capable graphics cards will obviously perform less well. As always, your mileage will vary.
INSTALLATION
The distribution disk image includes two items needed to run Celestia:
* Celestia - the applcation package
* CelestiaResources - the resource folder
You should mount the disk image and copy these files to your hard disk. You may want to put the "Celestia" application package in your "Applications" folder ('~/Applications'), but you can put it somewhere else if you prefer. It is probably simplest to put the "CelestiaResources" resource folder in the same folder where you put the application, but there are a few other places where you may put it. When you run Celestia, the application looks for the resource folder in several places. First it looks in the folder which contains the application. If the resource folder is not there, the application then looks in the "Application Support" folder in your "Library" folder ('~/Library/Application Support'). If the resource folder is not there, the application then looks in the shared "Application Support" folder on your computer ('/Library/Application Support'). Finally, the application looks for the resource files in the "Resources" folder in the "Contents" folder inside the application package.
Note that to put the resource files inside the application package, you must copy the CONTENTS of the "CelestiaResources" folder into the "Resources" folder in the "Contents" folder inside the application package. (To get to these folders, control-click the "Celestia" application package to see its contextual menu and choose the "Show Package Contents" item.) This is not generally recommended. The resource files are not included in the distributed application package partly in order to reduce its size for download, but mainly because having the resources outside the application package simplifies user customization.
STARTUP
To launch Celestia, simply double-click the application icon.
HELP
The Help is very basic (opens KbdMouseJoyControls.txt). The available Celestia documentation should be of some use (although it does not include much information specific to the Mac OS X version) as the Mac version is generally similar to the versions for the other platforms.
SUPPORT
If you need further information or assistance, or wish to contribute to the Celestia Community, go on-line to the Celestia Forums at:
http://www.shatters.net/forum
FEATURES
This version of Celestia for Mac OS X was built using the Celestia 1.4.0 sources. It includes most of the new features introduced in the 1.4.0 version of Celestia for Windows and Linux, except for the missing features listed below.
MISSING FEATURES
Several features which are available in Celestia on other platforms have not yet been implemented for the Mac. These include:
* Eclipse Finder
* Full screen graphics mode
* Still image capture (but you can always use the Mac OS's command+shift+4)
* Movie capture
BUGS
There are undoubtedly some annoying bugs in this version. (See TROUBLESHOOTING below for some suggestions.) Please report any new bugs you find on the Celestia Forums. (See SUPPORT above for the web address of the forums.)
USER INTERFACE
The user interface for the MacOS X version of Celestia differs somewhat from the versions on other platforms, and also departs in some respects from standard MacOS X application practices. The following sections briefly note some aspects of the user interface for the MacOS X version of Celestia.
MOUSE OPERATIONS
Drag without modifier keys to change your direction of view. Drag with the "Option" modifier key to change your location (direction relative to the target object). Drag with the "Command" modifier key to change your distance from the target object. Drag with the "Shift" modifier key to change your field of view.
KEY COMMANDS
Most of the standard Celestia key commands are implemented as described in the Help file (KbdMouseJoyControls.txt). These commands are also available from menus (see below).
MENUS
The menus now include essentially all the Celestia functions accessible from the keyboard. The key equivalent is indicated on the menu item. (Since the standard Celestia key commands are available these menu items are redundant, but they will be helpful for new users and can be used as a reference for key command equivalents as needed.) Note that only a few of the menu commands have "standard" Mac key equivalents, which require the use of the "Command" modifier key. Most of the menu commands have Celestia key command equivalents, which do not use the "Command" modifier key (but may use the "Control" modifier key).
CONTEXTUAL (POP-UP) MENUS
You can point to an object (planet, moon, star, galaxy) and control-click to display a pop-up contextual menu with commands that apply to the selected object. For several commands this is equivalent to, but often more convenient than, selecting the object and then selecting the command from the menu bar. A few commands are specific to the contextual menu. Note that bringing up a contextual menu will change the selection, even if no command is selected.
DISPLAY PREFERENCES
You can control various display features and options using menu and key commands. In addition, an integrated preferences panel is available. To use it, select the "Preferences..." command from the "Celestia" menu.) This panel is more convenient to use when changing several settings.
TROUBLESHOOTING
If you have problems with freezes or crashes, you can try the following:
* Turn off "Ring Shadows" in the "Preferences" panel
* Edit the file "celestia.cfg" in the "CelestiaResources" folder and remove the # from the beginning of the line that says:
# IgnoreGLExtensions [ "GL_ARB_vertex_program" ]
CREDITS
Kudos to Chris Laurel and the entire Celestia Development Team for version 1.4.0 of Celestia. The MacOS X port was developed by Bob Ippolito (originally) and Hank Ramsey (more recently). Many others in the Celestia Community (who cannot be listed here for fear of leaving someone out) have also made valuable contributions. Many thanks to everyone involved!
This README file was written by Hank Ramsey.