..  KORE documentation master file, created by
    sphinx-quickstart on Tue Jun 30 09:40:20 2020.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.

.. warning::
    This project is not complete.

.. warning::
    This project is currently in to process of moving from a custom ISA to the RISC-V ISA and thus some of this documentation is for RISC-V ISA and some is not.

Welcome to KORE's documentation!
================================

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



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

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

.. toctree::
    :maxdepth: 1
    :caption: Module Documentation

    modules/keyboard
    modules/screen
    modules/terminal

.. toctree::
    :maxdepth: 2
    :numbered:
    :caption: KS++ Documentation

    kpp/plans

.. toctree::
    :maxdepth: 2
    :numbered:
    :caption: Virtual Mechine Documentation

    vm/spec
    vm/structure

.. toctree::
    :maxdepth: 2
    :numbered:
    :caption: Assembly Documentation

    assembly/spec
    assembly/structure
    assembly/catalog

.. toctree::
    :maxdepth: 2
    :numbered:
    :caption: Instructions

    instructions/catalog

.. toctree::
    :maxdepth: 2
    :numbered:
    :caption: Machine Instruction Format (1s and 0s)

    instruction_encoding/data_format

.. toctree::
    :maxdepth: 2
    :numbered:
    :caption: Architecture Documentation

    architecture/design
    architecture/structure