.. _contents:

Boson
=============================

Welcome to Boson. It's an ecosystem for creating modular applications.
Boson consists of number of ready-to-use :doc:`modules </doc/modules_list>` and :doc:`BosonEditor </doc/BosonEditor>` 
application for joining this modules together in a "Boson project". 
Created Boson project can be exported to a standalone application.

Boson modules are mostly quite big blocks, solving particular tasks.
For example, there is a module for capturing data from webcamera, YOLO-based recognition module and module for sending results 
to other applications using OSC.

The idea behind Boson invention was to create a tool allowing easily join small creative applications into a bigger project
and provide GUI for adjusting their parameters.
Currently, Boson is not sound/video oriented, but sensors and data-processing oriented. 

The project is intended for artists, students and all other, who want to use various realtime data sources  
in their projects without low-level programming.

.. 
   .. sidebar:: Note

    

.. The idea, API and modules development by Denis Perevalov, BosonEditor was developed with Alexey Brylin.
   
* If you are looking what Boson can do for you, please see its :doc:`examples </doc/examples>`.

* To install and start working with BosonEditor go :doc:`here </doc/quickstart>`. Currently Boson is for Windows only.

   
Documentation contents
""""""""""""""""""""""

.. toctree::
   :maxdepth: 1

   doc/quickstart
   doc/examples
   doc/BosonEditor   
   doc/modules_list
..   developer/api