Build instructions
==================
This file is written in rst, so that one can use rst2pdf to create a PDF out of it.


Build on GNU/Linux
------------------

Install the dependencies. (see below)

Build it::

  ./build.sh

Ubuntu 13.10 and 14.04 LTS
~~~~~~~~~~~~~~~~~~~~~~~~~~

Install basic development tools fot Qt projects, plus liblo for OSC support::

  sudo apt-get install -y \
      liblo-dev \
      qttools5-dev-tools \
      qt5-default


Install GStreamer 1.0 libraries and plugins:

  sudo apt-get install -y \
      libgstreamer1.0-dev \
      libgstreamer-plugins-base1.0-dev \
      gstreamer1.0-gnonlin \
      gstreamer1.0-plugins-bad \
      gstreamer1.0-libav \
      gstreamer1.0-plugins-base \
      gstreamer1.0-plugins-base-apps \
      gstreamer1.0-plugins-good \
      gstreamer1.0-plugins-ugly \
      gstreamer1.0-x \
      gstreamer1.0-tools

Install extra packages if you want to build the documentation::

  sudo apt-get install -y \
      doxygen \
      graphviz \
      rst2pdf

To edit translations
--------------------
You might need to update the files::
  
  lupdate mapmap.pro 

Then, do this::
  
  lrelease mapmap.pro

Build on Mac OS X
-----------------
* Install the Apple Developer Tools. You need to register with a credit card in the Apple Store in order to download it.
* Install Qt5. You can get it from http://qt-project.org/downloads and choose the default location.
* Install liblo (compile from the tar.gz - it should install it to /usr/local)
* Install the GStreamer framework. You need the runtime and devel packages to be installed:
http://gstreamer.freedesktop.org/data/pkg/osx/1.2.4.1/gstreamer-1.0-devel-1.2.4.1-universal.pkg
http://gstreamer.freedesktop.org/data/pkg/osx/1.2.4.1/gstreamer-1.0-1.2.4.1-universal.pkg

http://gstreamer.freedesktop.org/data/pkg/osx/1.6.0/gstreamer-1.0-1.6.0-x86_64-packages.dmg
http://gstreamer.freedesktop.org/data/pkg/osx/1.6.0/gstreamer-1.0-1.6.0-x86_64.pkg
http://gstreamer.freedesktop.org/data/pkg/osx/1.6.0/gstreamer-1.0-devel-1.6.0-x86_64.pkg

Do this::

  ./build.sh

It will create a .app and a .dmg.

DMGVERSION.txt should be created automatically with "1" as its contents. Update to "2", and so on, if needed.


Use on OS X
-----------
Users can simply the following two packages:

http://gstreamer.freedesktop.org/data/pkg/osx/1.6.0/gstreamer-1.0-1.6.0-x86_64-packages.dmg
http://gstreamer.freedesktop.org/data/pkg/osx/1.6.0/gstreamer-1.0-1.6.0-x86_64.pkg

MapMap should then work.

If the appearance of the window of the OSC port number in the preferences seem corrupted, you might want to reset MapMap's preferences::

  rm -f ~/Library/Preferences/info.mapmap.MapMap.plist