# Read me for artoolkitX

## Build state

| macos | iOS | Android | Linux | Windows | Emscripten |
| ----- | --- | ------- | ----- | ------- | ---------- |
| [![Build Status](https://app.bitrise.io/app/65fba7d9f8fcd7ea/status.svg?token=SPF12BtEIvl3N4ytGX6ufw&branch=master)](https://www.bitrise.io/app/65fba7d9f8fcd7ea) | [![Build Status](https://app.bitrise.io/app/ea6b9e1aa405226c/status.svg?token=6mG1DSPAOxYpbJwu7m0UoQ&branch=master)](https://app.bitrise.io/app/ea6b9e1aa405226c) | [![Build Status](https://app.bitrise.io/app/242f3d0f8e8c3600/status.svg?token=nFHb56TVGwG4tHWaXkAOmg&branch=master)](https://www.bitrise.io/app/242f3d0f8e8c3600) | [![Build Status](https://app.bitrise.io/app/a03cbf8285d58247/status.svg?token=DBMpOGaixYVi7MtzGRnDpg&branch=master)](https://www.bitrise.io/app/a03cbf8285d58247)| [![Build status](https://dev.azure.com/artoolkitx/artoolkitx/_apis/build/status/build)](https://dev.azure.com/artoolkitx/artoolkitx/_build/latest?definitionId=1) | [![Build Status](https://app.bitrise.io/app/a1da22fd-b8b5-4832-ac46-079583386b29/status.svg?token=wptYd9uBHwBhWY7FoDasYQ&branch=master)](https://app.bitrise.io/app/a1da22fd-b8b5-4832-ac46-079583386b29) |

## What is artoolkitX?
artoolkitX version 1.0 is a software development kit (SDK) consisting of libraries and utilities that help developers implement the foundation of great augmented and mixed reality applications. The SDK includes some examples of applications that demonstrate the capabilities of artoolkitX. artoolkitX supports a wide-variety of platforms, including iOS and Android, and macOS, Windows, and Linux, and with experimental support for running on the web via Emscripten.

artoolkitX is free to use! The SDK is licensed under the GNU Lesser General Public License version 3.0, allowing for linking into both closed- and open-source software. Please read the file [license](LICENSE.txt) to understand your rights and obligations when using artoolkitX.

Complete source is provided, and we encourage users to favourite the project on GitHub at https://github.com/artoolkitx/artoolkitx and log issues and read the documentation provided there, and to join the artoolkitX community via our homepage at http://www.artoolkitx.org.

artoolkitX's development is currently generously sponsored by IQXR, LLC. The open source project is administered by long-term developers of ARToolKit and from and the open-source community.

For experienced developers wanting to quickly make use of the SDK, please read the file [Quick start](Quick%20start.md). To read about the changes in this release, please read the file [Release notes](Release%20Notes.md).

## Join the artoolkitX community:

* Join our forum and chat with other developers: https://forums.artoolkitx.org
* Report and help with issues: https://github.com/artoolkitx/artoolkitx/issues
* Follow us on social media: https://twitter.com/artoolkitx and https://www.facebook.com/artoolkitX/
