Skip to content

jazonshou/HolonomicLib

Repository files navigation

GitHub GitHub all releases Website Website

HolonomicLib

HolonomicLib is an open-source PROS (C++) library for VEX robots. The library specializes with holonomic drivetrains (ex. X-Drives or Mecanum Drives).

Installation

Use the PROS CLI to install HolonomicLib (if you installed PROS correctly, you do not need to install the CLI separately).

  1. Download the latest version of HolonomicLib (it should be HolonomicLib@VERSION_#.zip).
  2. Run the following in the root of your project:
pros conductor fetch HolonomicLib@VERSION_#.zip
pros conductor apply HolonomicLib
  1. Add #include "HolonomicLib/API.hpp" to your header file

Installation steps are also found in the documentation.

Usage

For step-by-step usage, follow the documentation.

For more specific usage, follow the API.

Contributing

Pull requests are welcome. Experimental changes should go to the development branch until deemed stable. For major changes, please open an issue first to discuss what you would like to change. For both issues and PRs, please follow the issues/PR template.

Please make sure to update tests as appropriate (that is, if tests get made).

License

GPL-3.0