Skip to content

Commit 40cd531

Browse files
Merge pull request #1 from purduesigbots/readme/update-1
Update README.md
2 parents 19d1d05 + 0055ff8 commit 40cd531

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,13 @@
44
[![Github All Releases](https://img.shields.io/github/downloads/OkapiLib/OkapiLib/total.svg)](https://github.com/OkapiLib/OkapiLib/releases)
55
[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
66

7-
# OkapiLib
7+
# OkapiLib 5
88

9-
A PROS library for programming VEX V5 robots. This library is intended to raise the floor for teams
9+
A maintainance fork of [OkapiLib](https://github.com/OkapiLib/OkapiLib), a PROS library for programming VEX V5 robots.
10+
Due to the widespread use of the library, we at the PROS team are working to maintain it so that it continues to
11+
work with future versions of PROS.
12+
13+
This library is intended to raise the floor for teams
1014
with all levels of experience. New teams should have an easier time getting their robot up and
1115
running, and veteran teams should find that OkapiLib doesn't get in the way or place any limits on
1216
functionality.
@@ -18,16 +22,24 @@ PROS documentation is hosted on the Purdue site
1822

1923
## Installing
2024

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

2529
## Contributing
2630

31+
Although we are not adding new features to OkapiLib, bug reports are still greatly appreciated!
32+
Additionally, we may still add changes and features that community contributes. If you
33+
have added a feature you would like to share with the rest of the community, please open a pull
34+
request!
35+
2736
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to help contribute to this project
2837
and make OkapiLib better. It covers submitting bugs and features, opening pull requests, and other
2938
formatting and code style requirements.
3039

40+
If you and/or your team would be interested it taking over Okapilib, please reach out to the PROS
41+
team to discuss it with us.
42+
3143
## Versioning
3244

3345
OkapiLib uses [SemVer](semver.org) for versioning. For available versions, see the [tags on this
@@ -40,7 +52,7 @@ file for the full license.
4052

4153
## Acknowledgments
4254

43-
The OkapiLib team would like to thank, for their contributions, knowledge, and/or otherwise,
44-
- [The PROS team](https://github.com/purduesigbots)
45-
- [Jonathan Bayless and Purdue Vex U team BLRS](https://github.com/purduesigbots/libblrs)
55+
We would like to thank all of those who helped to build OkapiLib and made it what it became:
56+
- Salmon
4657
- [Brad Miller and WPIlib](https://github.com/wpilibsuite/allwpilib)
58+
- The community that helped this library grow

0 commit comments

Comments
 (0)