Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 2.67 KB

README.md

File metadata and controls

58 lines (42 loc) · 2.67 KB

Test Docs codecov Github All Releases License: MPL 2.0

OkapiLib 5

A maintainance fork of OkapiLib, a PROS library for programming VEX V5 robots. Due to the widespread use of the library, we at the PROS team are working to maintain it so that it continues to work with future versions of PROS.

This library is intended to raise the floor for teams with all levels of experience. New teams should have an easier time getting their robot up and running, and veteran teams should find that OkapiLib doesn't get in the way or place any limits on functionality.

OkapiLib documentation is hosted on GitHub Pages here. PROS documentation is hosted on the Purdue site here.

Installing

OkapiLib is installed by default in new PROS projects. If it is not, you can install it using the PROS CLI. In your terminal, inside the project you want to install OkapiLib in, run prosv5 conduct apply okapilib.

Contributing

Although we are not adding new features to OkapiLib, bug reports are still greatly appreciated! Additionally, we may still add changes and features that community contributes. If you have added a feature you would like to share with the rest of the community, please open a pull request!

Please read CONTRIBUTING.md for details on how to help contribute to this project and make OkapiLib better. It covers submitting bugs and features, opening pull requests, and other formatting and code style requirements.

If you and/or your team would be interested it taking over Okapilib, please reach out to the PROS team to discuss it with us.

Versioning

OkapiLib uses SemVer for versioning. For available versions, see the tags on this repository.

License

This project is licensed under the Mozilla Public License, version 2.0 - see the LICENSE file for the full license.

Acknowledgments

We would like to thank all of those who helped to build OkapiLib and made it what it became: