Annotation of hatari/python-ui/README, revision 1.1.1.7

1.1       root        1: Hatari UI
                      2: ---------
                      3: 
                      4: Hatari UI is an out-of-process user interface for the Hatari Atari
                      5: ST/STe/TT/Falcon emulator and its built-in debugger which can
                      6: (optionally) embed the Hatari emulator window.
                      7: 
                      8: Having the UI in another process allows doing it with a higher level
1.1.1.2   root        9: language while avoiding adding GUI toolkit dependencies to Hatari
1.1       root       10: itself. The UI is done with PyGtk i.e. in Python language, using the
                     11: Gtk widget set.
                     12: 
                     13: The main points of this new UI over the Hatari internal one are its
1.1.1.7 ! root       14: configurability, more usable file selector, internationalization
        !            15: support and providing a GUI for the (console based) debugger included
        !            16: with the Hatari emulator.
1.1       root       17: 
                     18: Note: this is an additional UI, the built-in Hatari SDL UI isn't being
                     19: replaced or going anywhere!
                     20: 
                     21: 
                     22: Requirements
                     23: ------------
                     24: 
                     25: My guess at the required versions for the dependencies are:
1.1.1.5   root       26: - Python >= 2.6
1.1.1.3   root       27: - PyGtk >= 2.12   (on Debian/Ubuntu PyGtk is in python-gtk2 package)
1.1       root       28: 
1.1.1.2   root       29: Hatari UI is included with the Hatari sources:
1.1.1.4   root       30:        http://hg.tuxfamily.org/mercurialroot/hatari/hatari/file/tip/python-ui
1.1.1.2   root       31: 
1.1.1.5   root       32: Hatari UI has been tested on several Linux versions.  I would assume
1.1.1.7 ! root       33: it to work also on other unix systems such as Apple OSX. It may work
        !            34: with the Hatari Windows version, as long as it is built with socket
        !            35: support.
1.1       root       36: 
                     37: Embedding the Hatari emulator window is currently supported only for
                     38: systems using an X window system (from libSDL sources it would seem
                     39: that Windows would also support window embedding, but support for that
1.1.1.3   root       40: would need to be added both to Hatari and Hatari UI because SDL's
                     41: own embedding disables all keyboard events in SDL program).
1.1       root       42: 
1.1.1.7 ! root       43: Here are instructions on installing the dependencies for non-Linux
        !            44: platforms (neither tested nor supported as I don't use/have them):
        !            45:        http://pygtk.org/downloads.html
        !            46: 
1.1       root       47: 
                     48: Running
                     49: -------
                     50: 
                     51: Being a Python program, Hatari UI doesn't need to be built.
                     52: You can just run it from where you extracted it (or checked
1.1.1.5   root       53: it out of TuxFamily HG repo) by calling its wrapper script:
1.1       root       54:        /path/to/script/hatariui
                     55: 
                     56: Or you can run just the debugger:
                     57:        /path/to/script/debugui.py
                     58: 
1.1.1.2   root       59: But you can also install it to system along with Hatari:
1.1       root       60:        make install
                     61: 
                     62: 
                     63: Notes
                     64: -----
                     65: 
1.1.1.2   root       66: Hatari UI runs a Hatari version found on $PATH.  If you want
                     67: to use a version of Hatari that hasn't been installed, you
                     68: need to modify the search path, for example like this:
1.1.1.6   root       69:        PATH=../build/src:.:$PATH hatariui
1.1.1.2   root       70: 
1.1       root       71: If UI is started without the embedding option, the actions
                     72: (in menus and toolbars) have also shortcuts.  They cannot
                     73: be used when Hatari window is embedded because then those
                     74: shortcuts couldn't be used with Hatari.
                     75: 
                     76: 
1.1.1.7 ! root       77: A www-page with more information about Hatari UI is here:
        !            78:        http://koti.mbnet.fi/tammat/hatari/hatari-ui.shtml

unix.superglobalmegacorp.com

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