arktools / jsbsim Goto Github PK

Contents
--------

1) Introduction
2) Building with autoconf/automake
3) Contact


1) Introduction
---------------

JSBSim is a multi-platform, general purpose object-oriented Flight
Dynamics Model (FDM) written in C++. Jon Berndt and Tony Peden began
about mid-1998 writing JSBSim. As of this writing it is the default
FDM for FlightGear. JSBSim can also be run in a standalone batch mode
for testing and study. More information on JSBSim can be found at the
JSBSim home page here:

http://www.jsbsim.org


2) Building with autoconf/automake
----------------------------------

Unpack the distribution tarball (if needed - CVS users will have
downloaded the code directly) using your preferred method, and change
to the working directory. For example :

$ tar xvfz JSBSim-0.1.2.tar.gz
$ cd JSBSim-0.1.2

NOTE for CVS users: If you are using JSBSim from a CVS checkout, or
snapshot, you will need to create the initial configure script. The
commands to do this have been included in the 'autogen.sh' script, so
just :

$ ./autogen.sh [--no-configure]

If you wish to customise your version of JSBSim, use the following to
determine any build-time options you may be interested in.

$ ./configure --help

Then :

$ ./configure

This will check your system platform, compiler and other local
configuration variables needed to build JSBSim, and generates the
necessary Makefiles. Next :

$ make

Will compile the various classes, and build the JSBSim application.


3) Building JSBSim libraries
----------------------------

By default, the JSBSim libraries are not built. To build and install
the libraries, use:

$ ./autogen --enable-libraries [--disable-static] [--enable-shared]

The configure options can be used to select what libraries to build.

$ make install

Unless specified otherwise (with --prefix configure option), this will
install JSBSim libraries into '/usr/local/lib' and JSBSim headers
into '/usr/local/include/JSBSim'.


4) Contact
----------

For more information on JSBSim contact Jon Berndt at [email protected].


5) Building with CMake
-----------------------

You need to install qt4, boost, and openscenegraph to build the gui. The build 
has been tested on debian, mac, and mingw cross compilation. CMake can also
generate MSVC and Eclipse project files. See the next section for building
using MSVC project files generated from CMake.

Using the cmake-gui:

    Start cmake and tell it where the source directory for JSBSim is and select
    a build directory.

The commands to build with cmake on the command line:

    (Starting in JSBSim root source directory)
    mkdir build     (This creates a directory to keep all built files)
    cd build        (Change to the newly created directory)
    cmake ..        (Tell cmake where the  source directory is)
    make            (Execute make in your build directory to create the project)

The following options exists:
    - WITH_GUI : build the gui
    - WITH_ARKOSG : use embedded openscengraph graphics
    - WITH_BUILD_DEPS : attempt to automatically download and build dependencies

    You can use these options with cmake -DWITH_GUI=y -DWITH_ARKOSG=n -DWITH_BUILD_DEPS=y

6) Building Trimming/ Linearization GUI with MSVC on Windows
-----------------------

Tested with Microsoft Visual C++ 2008.

1. Install Qt-Win-Opensource from http://get.qt.nokia.com/qt/source/qt-win-opensource-4.8.0-vs2008.exe.
    Add C:\Qt\4.8.0\bin to Windows Path environment.

2. If you have a full (i.e non-express) version of VC2008, also install the Qt add-in from 
   http://get.qt.nokia.com/vsaddin/qt-vs-addin-1.1.10.exe.

3. With git clone get arksog 
   from https://github.com/arktools/arkosg.git.
 
   Both and jsbsim and arkosg should be placed in the same directory.

4. Install recent versions of Boost and OpenScenegraph. Unlike Flightgear, a binary build of Boost is 
   required as the thread and system libraries are used. Pre-built 32 bit versions of Boot and
   OpenScengraph are available on the 'net.
   This build has been tested with both libraries installed in C:\Program Files.
   Openscengraph and Boost binary directories need to be in the Path environment.   
   Flightgear cmake also works well with this setup.

5. Run cmake gui on arkosg. Cmake may ask for qmake.exe. Use the one in C:\Qt\4.8.0\bin. 
   Set C:/directory where jsbsim and arkosg are/install as the cmake install directory.
   Configure, sort out any not-found errors, and Generate.

6. Open arkosg/build/arkog.sln and build and install arkog with MSVC.

8. Repeat 6 and 7 for jsbsim.

9. Run install/jsbsimgui.exe.

10. Please let me know of any bugs, and if possible send fixes. ;-)
    Alan Teeder [email protected]

7) Packaging with CMake
-----------------------
After you have built the project using cmake you can package it by running the cpack command in the build directory.

Linux: cpack -G DEB (Generated a Debian package)
Mac: cpack -G PackageMaker (Mac Installer)
Windows cpack -G NSIS (Windows Installer)