.. lib3mf documentation master file

*********************************************
lib3mf v2.5.0 documentation
*********************************************

.. image:: https://github.com/3MFConsortium/lib3mf/workflows/Build/badge.svg?branch=master
	:target: https://travis-ci.org/3MFConsortium/lib3mf
	:alt: Build Status

.. image:: https://readthedocs.org/projects/lib3mf/badge/?version=latest
	:target: https://readthedocs.org/projects/lib3mf/
	:alt: Documentation Status

.. image:: https://img.shields.io/static/v1.svg?label=lib3mf&message=v2.3.2&color=green
	:alt: Version

.. image:: https://img.shields.io/static/v1.svg?label=platform&message=windows%20%7C%20macos%20%7C%20linux&color=lightgrey
	:alt: Supported platforms
	
.. image:: https://img.shields.io/static/v1.svg?label=license&message=BSD&color=green
	:target: source/license.html
	:alt: Simplified BSD License
	

.. role:: bash(code)
	:language: bash


Welcome! This is the documentation for lib3mf v2.5.0.

lib3mf is an implementation of the 3D Manufacturing Format file standard.

It provides 3MF reading and writing capabilities, as well as conversion and validation tools
for input and output data. lib3mf runs on Windows, Linux and MacOS and offers a clean and
easy-to-use API in various programming languages to speed up the development and keep integration
costs at a minimum.

As 3MF shall become an universal 3D Printing standard, its quick adoption is very important. 
This library shall lower all barriers of adoption to any possible user, let it be software 
providers, hardware providers, service providers or middleware tools.

.. _label-api-documentation:

API documentation
=================

- :doc:`C++ <source/Cpp/LandingPage>`
- :doc:`C <source/C/LandingPage>`
- :doc:`Python <source/Python/LandingPage>`
- :doc:`Pascal <source/Pascal/LandingPage>`
- :doc:`C# <source/CSharp/LandingPage>`
- :doc:`Golang <source/Golang/LandingPage>`
- :doc:`NodeJS <source/NodeJS/LandingPage>`


.. toctree::
	:maxdepth: 3
	:hidden:
	
	C++ <source/Cpp/LandingPage>
	C <source/C/LandingPage>
	Python <source/Python/LandingPage>
	Pascal <source/Pascal/LandingPage>
	C# <source/CSharp/LandingPage>
	Golang <source/Golang/LandingPage>
	NodeJS <source/NodeJS/LandingPage>
	

.. _label-obtaining_lib3mf:

Obtaining lib3mf
====================
Simply download the precompiled binary SDK https://github.com/3MFConsortium/lib3mf/releases.


Using lib3mf
====================
Allthough the different language bindings are kept as similar as possible,
the usage of lib3mf still depends your programming language.
You are best-off starting with one of the examples distributed in the SDK (https://github.com/3MFConsortium/lib3mf/releases).

In addition, the home pages for each language binding give detailed instructions on how to use them.


Meta Information
====================

:doc:`source/license`

`Reporting Bugs <https://github.com/3MFConsortium/lib3mf/blob/master/CONTRIBUTING.md#filing-issues>`_

`The 3MF Consortium <https://3mf.io/>`_

`Specification of the 3MF format <https://3mf.io/specification/>`_

Indices and tables
==================

* :ref:`genindex`
* :ref:`search`

