.. Supertag documentation master file, created by
   sphinx-quickstart on Sun Jul 26 02:18:54 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. toctree::
   :maxdepth: 2
   :hidden:

   installation
   usage
   config
   architecture
   development
   os_behavior
   database_schema

   tips_and_tricks
   glossary
   faq

Supertag
########

.. raw:: html

    <div style="display: flex; margin-bottom: 1rem;">
        <video style="width: 65%" loop autoPlay muted>
            <source src="https://s3-us-west-2.amazonaws.com/supertag.ai/docs_logo.mp4" type="video/mp4" />
        </video>
    </div>

.. image:: https://img.shields.io/travis/amoffat/supertag/master.svg?style=flat-square
    :target: https://travis-ci.org/amoffat/supertag
    :alt: Build Status
.. image:: https://img.shields.io/badge/Documentation-v0.1.3-1a6cff?style=flat-square&logo=read-the-docs&logoColor=white
    :target: https://amoffat.github.io/supertag/
    :alt: Docs
.. image:: https://img.shields.io/badge/Github-v0.1.3-ff7204?style=flat-square&logo=github&logoColor=white
    :target: https://github.com/amoffat/supertag
    :alt: Docs

Supertag is a tag-based file system, written in `Rust <https://www.rust-lang.org/>`_,
that provides a unique view of your files by removing the
hierarchy constraints typically imposed on files and folders. In other words, it allows you to think about your
files not as objects *stored* in folders, but as objects that can be *filtered* by folders.

Below, the file path ``/A/B/C`` yields the :term:`intersection` of all of the files that have been tagged with the
tags ``A``, ``B``, and ``C``. Notice that the resulting files do not live *inside* of the full path,
they simply appear there because they've been tagged with each part of the file path.
Supertag takes care of rendering a dynamic directory
structure through which you can filter and navigate these files.

.. image:: images/intersection-opt.gif
  :alt: Supertag file intersection

.. note::
   You ``/A/B/C`` yields the same file intersection as ``/C/B/A``, ``/B/C/A``, etc. It doesn't matter what
   order that the path tags are in, because we're simply dealing with the intersection of the tags.


Cool, right? See :ref:`Quickstart` for the crash course.