Getting Started
================

Introduction
-------------

Filers2 is a Kivy based application that plays and records video. It also
provides tools to compress the video after recording.

Usage
------

To use Filers2, you first need to install it, see :ref:`install-filers2`.

After it's installed, you can run it with ``python filers2/run_app.py`` or
if you have a pre-compiled app, just run the app by double clicking ``filers2.exe``.

Complete API documentation is at :ref:`filers2-root-api`.

See the :ref:`user-guide` for complete usage instructions.