======================
AcceleratXR SDK for C#
======================

The `AcceleratXR C# SDK <https://gitlab.acceleratxr.com/Core/sdk/sdk_csharp/>`__ is written
for compatibility with the .NET 4.x and .NET Standard 2.0 runtimes.

.. toctree::
   :hidden:
   :caption: About

   Features <https://acceleratxr.io/en/latest/features.html>
   Case Studies <https://www.acceleratxr.com/case-studies/>
   End User License Agreement <https://acceleratxr.io/en/latest/eula.html>
   Press <https://www.acceleratxr.com/press/>

.. toctree::
   :hidden:
   :caption: Learn

   Getting Started <https://acceleratxr.io/en/latest/getting_started/index.html>
   Accounts <https://acceleratxr.io/projects/account-services/en/latest/content>
   Social <https://acceleratxr.io/projects/social-services/en/latest/content>
   Samples & Tutorials <https://acceleratxr.io/en/latest/samples_and_tutorials/index.html>
   Tools & Utilities <https://acceleratxr.io/en/latest/tools.html>

.. toctree::
   :hidden:
   :caption: API Reference
   :glob:
   
   C++ SDK <https://acceleratxr.io/projects/sdk-cpp/en/latest/api>
   C# SDK <api/namespacelist>

.. toctree::
   :hidden:
   :caption: Get the Code

   GitLab <https://gitlab.acceleratxr.com>

.. toctree::
   :hidden:
   :caption: Get Involved

   Discord <https://discord.gg/wrfBR2Q>
   Google Groups <https://groups.google.com/g/acceleratxr>

.. toctree::
   :hidden:
   :caption: Other Links

   Demo <https://acceleratxr.com/demo>
   AcceleratXR Cloud <https://acceleratxr.com/pricing>

Looking for a Unity SDK, instead?
===============================
Ignore this guide -> Instead, jump to `SDK for Unity <https://acceleratxr.io/en/latest/getting_started/sdks/unity.html>`_.

Installation via NuGet
======================

The simplest way to install the C# SDK is `through NuGet <https://www.nuget.org/packages/acceleratxr.sdk/>`__:

To install using the NuGet Package Manager CLI, run the following command:

.. code-block::

   Install-Package acceleratxr.sdk

Building from Source
====================

Clone the repository containing the C# SDK using the following command.

.. code-block:: bash

    git clone https://gitlab.acceleratxr.com/Core/sdk/sdk_csharp

Building on Windows
~~~~~~~~~~~~~~~~~~~

You will need `.NET Standard 2.0` and `.NET Framework 4.6.1` components installed (that is generally included with Visual Studio).

This project is tested for use with Visual Studio 2019, for full compatibility:

1. Open the `sdk_csharp.sln` solution file.
2. [For updating `unity_sdk <https://gitlab.acceleratxr.com/Core/sdk/sdk_unity>`__] At the top-right, be sure to target `Unity`.
3. Select `Build Solution`.