Welcome to snr's documentation!
===============================

Starting out, you can read :doc:`user_guide/installation` to install snr and then dive into :doc:`user_guide/quickstart` to get started!

Also you might want to read the :doc:`user_guide/faq` for commonly asked questions. After that you might want to get a more deeper knowledge of snr with reading :doc:`user_guide/deeper_introduction` and :doc:`user_guide/shell_commands`.

For details on how to protect your devices from snr (and similar physical-based attacks), you can read :doc:`user_guide/protection`.

If you are interesting in developing your own payloads do not forget to read our dedicated payload development guide (:doc:`dev_guide/payload_development/develop_your_own`)!

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   user_guide/installation
   user_guide/quickstart
   user_guide/deeper_introduction
   user_guide/payload_categories
   user_guide/shell_commands
   user_guide/configuration
   user_guide/protection
   user_guide/faq


.. toctree::
   :maxdepth: 2
   :caption: Payload Development Guide

   dev_guide/payload_development/develop_your_own
   dev_guide/payload_development/terminology
   dev_guide/payload_development/basics
   dev_guide/payload_development/payload_class
   dev_guide/payload_development/payload_types
   dev_guide/payload_development/working_example
   dev_guide/payload_development/validation
   dev_guide/payload_development/partition_types
   dev_guide/payload_development/rootfs_versions
   dev_guide/payload_development/contributing_a_payload
   
.. toctree::
   :maxdepth: 2
   :caption: Command Development Guide

   dev_guide/command_development/develop_your_own
   dev_guide/command_development/highlighting

.. toctree::
   :maxdepth: 2
   :caption: Snr Changelog

   dev_guide/changelog


.. toctree::
   :maxdepth: 3
   :caption: API Reference

   ref/snr
   fdl


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

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

License
=======

:doc:`fdl`

Copyright (C) 2024 GlobularOne.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".