.. nesbox documentation master file, created by
   sphinx-quickstart on Thu Mar 12 17:29:28 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Nesbox Docs
===========

``nesbox`` is *not* for playing Nintendo Entertainment System games, if you wish to use ``nesbox`` ensure that you meet
the following:

- Is confident with the C# programming language
- Has a relatively modern System capable of running NET 9
- Is aware of how the hardware of the NES behaves to beyond a introductory level

To begin using ``nesbox`` please ensure that you have the following:

- ``SDL3`` installed.
- An IDE with debugging capabilities configured

If you are using ``nesbox`` to implement unimplemented hardware, you should not require modifying the source code beyond
the ``Implementation`` class and any class you make. If it is required that you contribute to ``nesbox`` to introduce
the behavior you require please make a merge request! ``nesbox`` is only in English as of now, I have no plans to change
this at this point in time.

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