| 1 | /*! \mainpage MAVA Logger X Developers' Documentation
|
|---|
| 2 | *
|
|---|
| 3 | * \section intro Introduction
|
|---|
| 4 | *
|
|---|
| 5 | * This (partially generated) documentation describes the MAVA Logger
|
|---|
| 6 | * X from a developer's perspective. Its purpose is to give enough
|
|---|
| 7 | * information, so that a developer could understand how the software
|
|---|
| 8 | * works in general, and easily understand the code to be able to make
|
|---|
| 9 | * modifications to it.
|
|---|
| 10 | *
|
|---|
| 11 | * \section overview Overview
|
|---|
| 12 | *
|
|---|
| 13 | * The application was written in
|
|---|
| 14 | * <a href="http://python.org">Python 2</a>. The Python wrapper
|
|---|
| 15 | * <a href="http://gtk.org">Gtk+</a> toolkit was used for the graphical
|
|---|
| 16 | * user interface. The program is designed to run on both Windows and
|
|---|
| 17 | * Linux, though as of this writing only the Windows version can be
|
|---|
| 18 | * used practically. However, Linux distributions move towards Gtk+ 3
|
|---|
| 19 | * as the primary toolkit, while it has no reliable port for Windows
|
|---|
| 20 | * yet. Therefore it was decided to support both Gtk+ 2 and 3
|
|---|
| 21 | * depending on the platform. For Gtk+ 2 the
|
|---|
| 22 | * <a href="http://pygtk.org">PyGTK</a> wrapper is used, while for Gtk+
|
|---|
| 23 | * 3 the <a href="https://live.gnome.org/PyGObject">PyGObject</a>
|
|---|
| 24 | * bindings. See the mlx.gui.common module for information on how the
|
|---|
| 25 | * differences between these toolkits are handled.
|
|---|
| 26 | *
|
|---|
| 27 | * At present only Microsoft Flight Simulator 2004 and X (also,
|
|---|
| 28 | * perhaps, Prepar3D) are supported, and are accessed via the
|
|---|
| 29 | * <a href="http://www.schiratti.com/dowson.html">FSUIPC</a>
|
|---|
| 30 | * interface. The author has created a Python mapping for it, which
|
|---|
| 31 | * has been submitted for inclusion into the SDK, so it will hopefully
|
|---|
| 32 | * appear in its next version. It is planned to support X-Plane in the
|
|---|
| 33 | * near future (hopefully by the end of 2012) on both Linux and
|
|---|
| 34 | * Windows.
|
|---|
| 35 | *
|
|---|
| 36 | * \subsection overview_devenv Development environment
|
|---|
| 37 | *
|
|---|
| 38 | * The software is primarily being developed on Linux, but is possible
|
|---|
| 39 | * to perform development on Windows as well. You need to have Python
|
|---|
| 40 | * 2.7.x installed as well as one of the above mentioned wrappers for
|
|---|
| 41 | * Gtk+ and Gtk+ itself. Since Python is an interpreted language,
|
|---|
| 42 | * there is no need for any special build system.
|
|---|
| 43 | *
|
|---|
| 44 | * Python and Gtk+ are readily available on most Linux distributions,
|
|---|
| 45 | * but some links are probably useful for Windows users:
|
|---|
| 46 | * \li Python has its own Windows installers: http://www.python.org/download/releases
|
|---|
| 47 | * \li PyGTK provides convenient all-in-one installers including Gtk+
|
|---|
| 48 | * itself: http://ftp.gnome.org/pub/GNOME/binaries/win32/pygtk/2.24
|
|---|
| 49 | * \li The Windows version uses some Python extensions: http://sourceforge.net/projects/pywin32/files
|
|---|
| 50 | * \li To create install packages, you also need py2exe: <a href="http://www.py2exe.org/">http://www.py2exe.org</a>,
|
|---|
| 51 | * \li as well as the Nullsoft Install System: http://nsis.sourceforge.net/Main_Page
|
|---|
| 52 | */
|
|---|
| 53 | |
|---|
