Annotation of previous/readme.txt, revision 1.1.1.1

1.1       root        1: 
                      2: 
                      3:                                     Hatari
                      4: 
                      5:                                  Version 1.4
                      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 Known problems
                     16: 4. Running Hatari
                     17: 5. Contact
                     18: 
                     19: 
                     20:  1) License
                     21:  ----------
                     22: 
                     23: This program is free software; you can redistribute it and/or modify it under
                     24: the terms of the GNU General Public License as published by the Free Soft-
                     25: ware Foundation; either version 2 of the License, or (at your option) any
                     26: later version.
                     27: 
                     28: This program is distributed in the hope that it will be useful, but WITHOUT ANY
                     29: WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
                     30: FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
                     31: 
                     32: You should have received a copy of the GNU General Public License along with
                     33: this program; if not, write to the
                     34:  Free Software Foundation, Inc.,
                     35:  51 Franklin Street, Fifth Floor, Boston,
                     36:  MA  02110-1301, USA
                     37: 
                     38: 
                     39:  2) What is Hatari?
                     40:  ------------------
                     41: 
                     42: Hatari is an Atari ST/STE/TT/Falcon emulator for Linux, FreeBSD, NetBSD,
                     43: BeOS, Mac-OSX and other Systems which are supported by the SDL library.
                     44: Unlike most other open source ST emulators which try to give you a good
                     45: environment for running GEM applications, Hatari tries to emulate the hardware
                     46: as close as possible so that it is able to run most of the old Atari games
                     47: and demos.  Because of this, it may be somewhat slower than less accurate
                     48: emulators.
                     49: 
                     50: 
                     51:  3) Compiling and installing
                     52:  ---------------------------
                     53: 
                     54: For using Hatari, you need to have installed the following libraries:
                     55: 
                     56: Required:
                     57: - The SDL library (http://www.libsdl.org)
                     58: - The zlib compression library (http://www.gzip.org/zlib/)
                     59: 
                     60: Optional:
                     61: - The PNG image library for PNG format screenshots and to decrease
                     62:   AVI video recording file sizes (http://www.libpng.org/)
                     63: - The GNU Readline library for Hatari debugger command line editing
                     64: - The Xlib library to support Hatari Python UI window embedding on
                     65:   systems with the X window system (Linux and other unixes) 
                     66: - The portaudio library for Falcon microphone handling
                     67: 
                     68: Don't forget to also install the header files of these libraries for compiling
                     69: Hatari (some Linux distributions use separate development packages for these
                     70: header files)!
                     71: 
                     72: For compiling Hatari, you need a C compiler (preferably GNU C), and a working
                     73: CMake installation (see http://www.cmake.org/ for details).
                     74: 
                     75: CMake can generate makefiles for various flavours of "Make" (like GNU-Make)
                     76: and various IDEs like Xcode on Mac OS X. To run CMake, you've got to pass the
                     77: path to the sources of Hatari as parameter, for example run the following if
                     78: you are in the topmost directory of the Hatari source tree:
                     79:        cmake .
                     80: 
                     81: If you're tracking Hatari version control, it's preferable to do
                     82: the build in a separate build directory as above would overwrite
                     83: the (non-CMake) Makefiles coming with Hatari:
                     84:        mkdir -p build
                     85:        cd build
                     86:        cmake ..
                     87: 
                     88: Have a look at the manual of CMake for other options. Alternatively, you can
                     89: use the "cmake-gui" program to configure the sources with a graphical
                     90: application.
                     91: 
                     92: For your convenience we also ship an old-fashioned configure script which can
                     93: be used as a wrapper for running cmake. Type "./configure --help" to see the
                     94: options of this script.
                     95: 
                     96: Assuming that you've used the Makefile generator of CMake, and cmake finished
                     97: the configuration successfully, you can compile Hatari by typing "make". If all
                     98: works fine, you'll get the executable "hatari" in the src/ subdirectory of the
                     99: build tree. You can then install the emulator by typing "make install".
                    100: 
                    101: 
                    102:  3.1) Known problems
                    103: 
                    104: RHEL 5 and the derived CentOS v5.x Linux distributions ship
                    105: with a broken readline library:
                    106:        https://bugzilla.redhat.com/show_bug.cgi?id=499837
                    107: 
                    108: To get CMake readline detection and linking working on them,
                    109: you need to give these as arguments to the "cmake" command above:
                    110:    -DCMAKE_C_FLAGS=-lncurses -DCMAKE_EXE_LINKER_FLAGS=-lncurses
                    111: 
                    112: 
                    113:  4) Running Hatari
                    114:  -----------------
                    115: 
                    116: For information about how to use the running emulator, please read the file
                    117: doc/manual.html. Here are just some hints for the impatient people:
                    118: Before you can run the emulator, you need a TOS ROM image that should be
                    119: stored as "tos.img" in the data directory of the emulator (see the variable
                    120: DATADIR in Makefile.cnf).
                    121: 
                    122: While the emulator is running, you can open the configuration menu by
                    123: pressing F12, the F11 key will toggle fullscreen/windowed mode.
                    124: Pressing ALTGR-q will quit the emulator.
                    125: 
                    126: 
                    127:  5) Contact
                    128:  ----------
                    129: 
                    130: If you want to contact the authors of Hatari, please have a look at the file
                    131: doc/authors.txt for the e-mail addresses or use the Hatari mailing list.
                    132: 
                    133: Visit the project pages of Hatari on Berlios.de for more details:
                    134: 
                    135:  http://developer.berlios.de/projects/hatari/
                    136: 

unix.superglobalmegacorp.com

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