.. BusKill documentation master file, created by
   sphinx-quickstart on Sun Jul 12 17:40:41 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. |nbsp| unicode:: 0xA0
   :trim:


Welcome to BusKill's documentation!
===================================

Welcome! BusKill's documentation is split into 4 main parts:

- :ref:`hardware_usr`
- :ref:`software_usr`
- :ref:`hardware_dev`
- :ref:`software_dev`

For information on using the BusKil App, see :ref:`software_usr`.

For information on how to build your own BusKill cable, see :ref:`hardware_dev`.

.. note:: If you're looking to order a pre-assembled BusKill cable, you can `buy a BusKill cable here <https://buskill.in/buy>`_.

	Revenue from `BusKill cable purchases <https://buskill.in/buy>`_ go to supporting this open-source project. Please consider purchasing a cable or making a :ref:`donation <donate>` if you build your own.

..
   Hack to fix bug where figure below gets put inside the note above
|nbsp| 

.. figure:: /images/buskill_featuredImageLight.jpg
  :align: center

  source: `Michael Altfield's tech blog <https://tech.michaelaltfield.net/2020/01/02/buskill-laptop-kill-cord-dead-man-switch/>`_

.. toctree::
   :caption: What is BusKill?:

   introduction/index
   faq

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   hardware_usr/index
   software_usr/index
   hardware_dev/index
   software_dev/index

.. toctree::
   :maxdepth: 2
   :caption: More:

   security/index
   support
   contributing
   changelog
   license
   attribution

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


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