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

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