Skip to content
This repository has been archived by the owner on Jan 25, 2024. It is now read-only.

Latest commit

 

History

History
24 lines (15 loc) · 1019 Bytes

index.rst

File metadata and controls

24 lines (15 loc) · 1019 Bytes

j5 Framework Documentation

What is j5?

j5 is a Python 3 framework that aims to make building consistent APIs for robotics easier. It was created to reduce the replication of effort into developing the separate, yet very similar APIs for several robotics competitions. Combining the common elements into a single library with support for various hardware gives a consistent feel for students and volunteers. This means more time to work on building robots!

Please note that this documentation is not aimed at the average competitor. It is for used by developers of the API, competition volunteers and more advanced students wishing to extend on our API for their robots. Support is discretionary to the individual competition. j5 will not provide direct support to compeititors at the time of writing.

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   usage/installation
   usage/quickstart

   concepts/index

   hardware/index

   development/index

   api/modules