Setting Up Your Programming Environment

By following the subsequent steps, you should be able to successfully compile Mira's source code. There are instructions for Linux, Mac OS X and Windows.

Linux

Please note that the provided instructions assume that your Linux distribution is Debian or Debian-based. If it is not, please install the packages using your distribution's installer.

Core Build Packages

You will need to download the following core packages (on Debian or Ubuntu, you can do so with the terminal command: sudo apt-get install PACKAGE_NAME);

  • g++
  • build-essential
  • libgtk2.0-dev

Boost

It is best to install the latest version of Boost which is officially supported by the Mira Core Development Team (see below) or, alternatively, the latest version which is officially supported by CMake (please see the note on the FindBoost module in the CMake documentation).

To download Boost, find the relevant version on Boost Version History and download the .tar.gz package (such as boost_1_42_0.tar.gz).

Finally, run the following commands to extract and install Boost:

tar xzvf boost_1_42_0.tar.gz
cd boost_1_42_0/
./bootstrap.sh --with-libraries=all --prefix=/usr/local --libdir=/usr/local/lib --includedir=/usr/local/include
sudo ./bjam install

And, finally, set the BOOST_ROOT environment variable in your .bashrc file:

echo "export BOOST_ROOT=/usr/local/include" >> ~/.bashrc

The Mira Core Development Team is currently using Boost 1.44.
For more information regarding Boost, visit Boost.org.

Qt 4

The Qt 4 Application Development Open Source libraries can be downloaded from the Qt Software website. Visit the download page, and download the Qt libraries for Linux/X11 package to your Desktop. Then run the following commands from a terminal window (make sure to replace the Qt version number with that of the one you downloaded):

cd ~/Desktop
tar xzvf qt-x11-opensource-src-4.5.3.tar.gz
cd qt-x11-opensource-src-4.5.3
./configure
make
sudo make install

CMake

CMake is a cross-platform Open Source build system which is used to build both Mira Client and Mira Server. To install it, download the Linux source code from CMake's website, extract it and then install it with the commands:

./configure
make
sudo make install

Avahi Development Libraries

Please note: the Avahi Development Libraries are currently only required to build the lp:~mira-dev/mira/p2p branch.

The Avahi development libraries are required to support LAN service discovery. You will need to download the following packages (on Debian or Ubuntu, you can do so with the terminal command: sudo apt-get install PACKAGE_NAME);

  • libavahi-client-dev
  • libavahi-core-dev
  • libavahi-qt4-dev

BitRock InstallBuilder

Please note: BitRock InstallBuilder is only required if you wish to configure and edit the installers for Mira Client or Server, NOT if you would like to install the applications themselves.

To install InstallBuilder, download the Enterprise version for Linux from BitRock's website. Then, in a terminal window, run:

chmod +x bitrock-installbuilder-6.3.bin
./bitrock-installbuilder-6.3.bin
And follow the instructions.

If you would like to unlock the full version, please request the Open Source licence (granted free of charge by the brilliant Sales team at BitRock) from Max Bossino on the Mira Development Mailing List.

Testing Your Environment

To test your development environment, try to download and build both Mira Client and Mira Server using the instructions found here.

Mac OS X

Please note that the provided instructions assume that you are using the latest version of Mac OS X, Snow Leopard (version 10.6).

Core Build Packages

The core build packages are included with Apple's Integrated Development Environment, Xcode. It is free to use Xcode for Mac OS X development: all you have to do is register for a free account on the Mac Dev Center, download the latest Universal binary (.dmg) installer package for Xcode and install it on your Mac.

The Mira Core Development Team is currently using Xcode 3.2.2.

Boost

Download the boost_1_42_0.tar.gz package from the Boost project's Downloads page on SourceForge: here.

Let's assume that you have downloaded the package to your ~/Downloads/ directory. Open a Terminal environment (Applications > Utilities > Terminal, in Finder) and run:

cd ~/Downloads/
tar xzvf boost_1_42_0.tar.gz
cd boost_1_42_0/
./bootstrap.sh
sudo ./bjam install

You will need to enter your password to run the final command, which installs the Boost libraries.

The Mira Core Development Team is currently using Boost 1.44.
For more information regarding Boost, visit Boost.org.
For more information on installing Boost on Mac OS X, please see the Boost Getting Started guide.

Qt 4

The easiest way of installing the Qt 4 Application Development Open Source libraries is using MacPorts.

Visit the MacPorts install page, choose to download the dmg disk image for Snow Leopard and save it to your Downloads directory. Once it has downloaded, open your Downloads directory in Finder and double-click the dmg file to install MacPorts.

When it has finished installing, run the following commands from a Terminal environment:

sudo port selfupdate
sudo port install qt4-mac

The Mira Core Development Team is currently using Qt 4.6.2.
For more information on Qt, visit Qt Centre.
For more information on using MacPorts, visit the MacPorts User Guide.

CMake

CMake is a cross-platform Open Source build system which is used to build both Mira Client and Mira Server. To install it, download the Mac OS X Universal .dmg installer from CMake's website, and run the installer. When you are prompted about installing the Command Line Links to /usr/bin/, choose to install them.

The Mira Core Development Team is currently using CMake 2.8.1.

BitRock InstallBuilder

Please note: BitRock InstallBuilder is only required if you wish to configure and edit the installers for Mira Client or Server, NOT if you would like to install the applications themselves.

To install InstallBuilder, download the Enterprise version for Mac OS x, PPC and Intel from BitRock's website. Then extract the installbuilder-enterprise-6.3.1-osx-installer.zip file and run the installer package.

If you would like to unlock the full version, please request the Open Source licence (granted free of charge by the brilliant Sales team at BitRock) from Max Bossino on the Mira Development Mailing List.

The Mira Core Development Team is currently using BitRock InstallBuilder Enterprise 6.3.1.

Testing Your Environment

To test your development environment, try to download and build both Mira Client and Mira Server using the instructions found here.

Windows

Please note that the provided instructions have only been tested on Windows XP (32 bit).

Microsoft Visual C++ Express

Instructions to be added.

Boost

The easiest way of installing Boost on Windows is to download and run the BoostPro Binary Installer for Visual C++ for whichever version of Boost you would like to install. This installer, provided by BoostPro Computing, will automatically place the Boost source, documentation, and compiled 32-bit library binaries on your system.

The Mira Core Development Team is currently using Boost 1.44.
For more information regarding Boost, visit Boost.org.

Qt 4

The Qt 4 Application Development Open Source libraries can be downloaded from the Qt Software website. Visit the download page, and then download and install the Qt libraries for Windows (VS 2008) package.

CMake

CMake is a cross-platform Open Source build system which is used to build both Mira Client and Mira Server. To install it, download the Windows installer from CMake's website and run it.

BitRock InstallBuilder

Please note: BitRock InstallBuilder is only required if you wish to configure and edit the installers for Mira Client or Server, NOT if you would like to install the applications themselves.

To install InstallBuilder, download the Enterprise version for Windows from BitRock's website, and run the installer.

If you would like to unlock the full version, please request the Open Source licence (granted free of charge by the brilliant Sales team at BitRock) from Max Bossino on the Mira Development Mailing List.

Testing Your Environment

To test your development environment, try to download and build both Mira Client and Mira Server using the instructions found here.

 
development/environment_setup.txt · Last modified: 2011/09/20 17:10 by j_k9
 
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki