Return to readme.hatari.txt CVS log

Up to [Previous NeXT emulator] / previous

Annotation of previous/readme.hatari.txt, revision 1.1

1.1     ! root        1: 
        !             2: 
        !             3:                                     Hatari
        !             4: 
        !             5:                                  Version 1.5
        !             6: 
        !             7:                           http://hatari.berlios.de/
        !             8: 
        !             9: 
        !            10: Contents:
        !            11: ---------
        !            12: 1. License
        !            13: 2. What is Hatari?
        !            14: 3. Compiling and installing
        !            15:    3.1 WinUAE and "old" UAE CPU cores
        !            16:    3.2 Known problems
        !            17:    3.3 Notes for Linux distribution packagers
        !            18: 4. Running Hatari
        !            19: 5. Contact
        !            20: 
        !            21: 
        !            22:  1) License
        !            23:  ----------
        !            24: 
        !            25: This program is free software; you can redistribute it and/or modify it under
        !            26: the terms of the GNU General Public License as published by the Free Soft-
        !            27: ware Foundation; either version 2 of the License, or (at your option) any
        !            28: later version.
        !            29: 
        !            30: This program is distributed in the hope that it will be useful, but WITHOUT ANY
        !            31: WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
        !            32: FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
        !            33: 
        !            34: You should have received a copy of the GNU General Public License along with
        !            35: this program; if not, write to the
        !            36:  Free Software Foundation, Inc.,
        !            37:  51 Franklin Street, Fifth Floor, Boston,
        !            38:  MA  02110-1301, USA
        !            39: 
        !            40: 
        !            41:  2) What is Hatari?
        !            42:  ------------------
        !            43: 
        !            44: Hatari is an Atari ST/STE/TT/Falcon emulator for Linux, FreeBSD, NetBSD,
        !            45: BeOS, Mac-OSX and other Systems which are supported by the SDL library.
        !            46: Unlike most other open source ST emulators which try to give you a good
        !            47: environment for running GEM applications, Hatari tries to emulate the hardware
        !            48: as close as possible so that it is able to run most of the old Atari games
        !            49: and demos.  Because of this, it may be somewhat slower than less accurate
        !            50: emulators.
        !            51: 
        !            52: 
        !            53:  3) Compiling and installing
        !            54:  ---------------------------
        !            55: 
        !            56: For using Hatari, you need to have installed the following libraries:
        !            57: 
        !            58: Required:
        !            59: - The SDL library v1.2.10 or newer (http://www.libsdl.org)
        !            60: - The zlib compression library (http://www.gzip.org/zlib/)
        !            61: 
        !            62: Optional:
        !            63: - The PNG image library for PNG format screenshots and to decrease
        !            64:   AVI video recording file sizes (http://www.libpng.org/)
        !            65: - The GNU Readline library for Hatari debugger command line editing
        !            66: - The Xlib library to support Hatari Python UI window embedding on
        !            67:   systems with the X window system (Linux and other unixes) 
        !            68: - The portaudio library for Falcon microphone handling
        !            69: 
        !            70: Don't forget to also install the header files of these libraries for compiling
        !            71: Hatari (some Linux distributions use separate development packages for these
        !            72: header files)!
        !            73: 
        !            74: For compiling Hatari, you need a C compiler (preferably GNU C), and a working
        !            75: CMake installation (see http://www.cmake.org/ for details).
        !            76: 
        !            77: CMake can generate makefiles for various flavours of "Make" (like GNU-Make)
        !            78: and various IDEs like Xcode on Mac OS X. To run CMake, you've got to pass the
        !            79: path to the sources of Hatari as parameter, for example run the following if
        !            80: you are in the topmost directory of the Hatari source tree:
        !            81:        cmake .
        !            82: 
        !            83: If you're tracking Hatari version control, it's preferable to do
        !            84: the build in a separate build directory as above would overwrite
        !            85: the (non-CMake) Makefiles coming with Hatari:
        !            86:        mkdir -p build
        !            87:        cd build
        !            88:        cmake ..
        !            89: 
        !            90: Have a look at the manual of CMake for other options. Alternatively, you can
        !            91: use the "cmake-gui" program to configure the sources with a graphical
        !            92: application.
        !            93: 
        !            94: For your convenience we also ship an old-fashioned configure script which can
        !            95: be used as a wrapper for running cmake. Type "./configure --help" to see the
        !            96: options of this script.
        !            97: 
        !            98: Assuming that you've used the Makefile generator of CMake, and cmake finished
        !            99: the configuration successfully, you can compile Hatari by typing "make". If all
        !           100: works fine, you'll get the executable "hatari" in the src/ subdirectory of the
        !           101: build tree. You can then install the emulator by typing "make install".
        !           102: 
        !           103: 
        !           104:  3.1) WinUAE and "old" UAE CPU cores
        !           105: 
        !           106: By default Hatari is built with the "old" UAE CPU core used in the earlier
        !           107: Hatari releases, but the new v1.5 supports also new & experimental WinUAE CPU
        !           108: core which offers better cycle accuracy (especially for Falcon emulation) and
        !           109: in future also some potential extra features like MMU support.
        !           110: 
        !           111: The WinUAE CPU core can be enabled by toggling the ENABLE_WINUAE_CPU
        !           112: variable in the Hatari CMake configuration (e.g. with the interactive
        !           113: "ccmake" program).  Alternatively, you can run "./configure
        !           114: --enable-winuae-cpu", which will run cmake with the correct
        !           115: parameters.
        !           116: 
        !           117: The plan is to eventually (in the next version) have WinUAE CPU core
        !           118: enabled by default and deprecate the "old" UAE CPU core, but currently
        !           119: WinUAE CPU core is still lacking all the ST/STE specific tweaks, proper
        !           120: testing for ST/STE compatibility and some of the debugger support.
        !           121: 
        !           122: 
        !           123:  3.2) Known problems
        !           124: 
        !           125: Old RHEL 5 and the derived CentOS v5.x Linux distributions ship
        !           126: with a broken readline library:
        !           127:        https://bugzilla.redhat.com/show_bug.cgi?id=499837
        !           128: 
        !           129: To get CMake readline detection and linking working on them,
        !           130: you need to give these as extra arguments to the "cmake" command:
        !           131:    -DCMAKE_C_FLAGS=-lncurses -DCMAKE_EXE_LINKER_FLAGS=-lncurses
        !           132: 
        !           133: 
        !           134:  3.3) Notes for Linux distribution packagers
        !           135: 
        !           136: If Hatari package will have two application menu entries for Hatari,
        !           137: one for the Python UI embedding Hatari, and another one for the plain
        !           138: SDL version, the latter could open also a terminal window for Hatari
        !           139: command line debugger and its console messages:
        !           140: x-terminal-emulator -T "Hatari debug window, invoke debugger with AltGr+Pause" -e hatari
        !           141: 
        !           142: tools/hatari-tos-register.sh is a minimal example of Linux init script
        !           143: registering Hatari as a (binfmt_misc) handler for TOS binaries.
        !           144: 
        !           145: Alternatively one could add a mime type for TOS binaries with xdg-mime:
        !           146:   http://portland.freedesktop.org/xdg-utils-1.0/xdg-mime.html
        !           147: But registering handlers for mime-types seems desktop specific.
        !           148: 
        !           149: 
        !           150:  4) Running Hatari
        !           151:  -----------------
        !           152: 
        !           153: For information about how to use the running emulator, please read the file
        !           154: doc/manual.html. Here are just some hints for the impatient people:
        !           155: Before you can run the emulator, you need a TOS ROM image that should be
        !           156: stored as "tos.img" in the data directory of the emulator (see the variable
        !           157: DATADIR in Makefile.cnf).
        !           158: 
        !           159: While the emulator is running, you can open the configuration menu by
        !           160: pressing F12, the F11 key will toggle fullscreen/windowed mode.
        !           161: Pressing ALTGR-q will quit the emulator.
        !           162: 
        !           163: 
        !           164:  5) Contact
        !           165:  ----------
        !           166: 
        !           167: If you want to contact the authors of Hatari, please have a look at the file
        !           168: doc/authors.txt for the e-mail addresses or use the Hatari mailing list.
        !           169: 
        !           170: Visit the project pages of Hatari on Berlios.de for more details:
        !           171: 
        !           172:  http://developer.berlios.de/projects/hatari/
        !           173: 

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.