Orbiter.NET -
Installation Instructions

1. Required components
----------------------

To compile the sources of Orbiter.NET, you need:

* The latest Orbiter release (base + SDK packages), available from the
  download page at the Orbiter site http://orbit.medphys.ucl.ac.uk/

* A Visual Studio version capable of reading VS8 solutions and projects. Free
  C# and Managed C++ compilers for the .NET framework 2.0 may work as well, but
  no batch script or similar compilation packages are provided other than VS8
  solutions.

* To recompile the source documentation you will need Microsoft Sandcastle from

  http://www.microsoft.com/downloads/details.aspx?familyid=e82ea71d-da89-42ee-a715-696e3a4873b2&displaylang=en

  There is a Sandcastle-Builder project file in Orbitersdk/samples/Orbiter.NET
  which was used to generate the compressed html help file
  Doc/Orbiter.NET/Orbiter.NET.chm also included in the repository. You can get
  Sandcastle-Builder from
  
  http://www.codeplex.com/SHFB


2. Installation
---------------

For a first-time installation only:

* Be sure that Microsoft .NET framework 2.0 is installed.

* Create a directory for the Orbiter distribution, e.g.
  Program Files\Orbiter.NET
 
* Download the Orbiter.NET source tree into the Orbiter directory:

  svn co https://orbiterdotnet.svn.sourceforge.net/svnroot/orbiterdotnet orbiterdotnet

  You should end up with a directory "Orbiter.NET" inside your Orbiter SDK
  samples directory.
 
* Install the latest Orbiter release by unpacking the base package
  (orbiter060929_base.zip) and the SDK package (orbiter060929_sdk.zip) in
  that directory. Make sure to preserve the directory structure of the
  zip archives.

For each update of the sources:

* Update to the latest Orbiter.NET source tree as described for the first-time
  installation.


* Open the Orbiter.NET solution (for VS8, the solution file is in
  Orbitersdk/samples/Orbiter.NET/Orbiter.NET.sln) and compile.


3. Testing the ShuttlePBdotNET managed vessel
--------------------------

* If you're not able to compile the sources, there are precompiled binaries in
  the repository (which not necessarily reflect the current source status).
  The following 3 can be used directly:  
  * Modules/ShuttlePBdotNET.dll
  * Modules/DotNet/Orbiter.StockVessels.dll
  * Modules/DotNet/ShuttlePBdotNet.dll
  The following 2 must be installed into the global assembly cache via "gacutil"
  or similar tools for the system to function properly (you don't have to do
  this if you compiled with VS8, since copying is included as post-build step):
  * Orbitersdk/samples/Orbiter.NET/Orbiter.Interfaces/bin/Debug/Orbiter.Interfaces.dll
  * Orbitersdk/samples/Orbiter.NET/Orbiter.Wrapper/bin/debug/Orbiter.Wrapper.dll

* Start Orbiter with an arbitrary scenario and the ScnEditor module activated.

* Use the scenario editor to add a ShuttlePBdotNET.
