.. ZestCode documentation master file
.. toctree::
    :maxdepth: 1
    :caption: Contents:
    :hidden:

    license
    STRUCTURE
    STYLEGUIDE
    CONTRIBUTING

.. |check| raw:: html

    <input checked=""  disabled="" type="checkbox">

.. |uncheck| raw:: html

    <input disabled="" type="checkbox">



Welcome to ZestCode's documentation!
====================================
.. attention::
    ZestCode is under heavy development, and we'd greatly appreciate any contributors! Consider joining our `Discord Server <https://discord.gg/vNMXCvVwdY>`_ if you are interested.

    ZestCode is a truly open-source framework for the VEX V5. It's a PROS fork, and exists to address some PROS issues, particularly in reliability, tooling, and community input.

WIP Why ZestCode?
-----------------------------------
- |check| designed to be easy to contribute to
- |check| can be built from source
- |check| public development discussions and decision making
- |uncheck| superior contributor documentation
- |uncheck| superior build system
- |uncheck| more understandable compiler errors/warnings
- |uncheck| faster build times
- |uncheck| smarter package management
- |uncheck| deterministic builds

FAQ
-----------------------------------

.. admonition:: Is ZestCode Legal?
    Yup, 100% legal. It is not prohibited in the V5RC, VURC, or VAIRC game manual, and it's legal from a copyright standpoint.

.. admonition:: Why Can ZestCode Be Compiled From Source, But PROS Can't?
    PROS depends on _libv5rts_, which is a private version of the VEX SDK. ZestCode depends on _libv5rta_, which is public.

Acknowledgements
-----------------------------------
The authors of ZestCode would like to thank the developers of PROS for their years of service, and for paving the way for alternatives like ZestCode to even exist in the first place. We'd also like to thank the developers of vexide, ZestCode wouldn't exist if not for their feats.

API Reference
====================================
.. autodoxygenindex::
    :project: common