diff --git a/README.md b/README.md index 2ec65aeb67..1aa116fa09 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ # opendbc -opendbc is a Python API for your car. Read the speed, steering angle, etc. Send gas, brake, and steering commands. -It's used in [openpilot](https://github.com/commaai/openpilot). +opendbc is a Python API for your car. Read the speed, steering angle, and more. Send gas, braking, and steering commands. + +## Structure +* [`opendbc/dbc/`](opendbc/dbc/) is a repository of [DBC](https://en.wikipedia.org/wiki/CAN_bus#DBC) files +* [`opendbc/can/`](opendbc/can/) is a library for parsing and building CAN messages from DBC files +* [`opendbc/car/`](opendbc/car/) is a high-level library for interfacing with cars using Python ## Quick start @@ -22,18 +26,3 @@ pytest . # Run the linter pre-commit run --all-files ``` - -Structure: -* [opendbc/dbc/](opendbc/dbc/) is a repository of [DBC](https://en.wikipedia.org/wiki/CAN_bus#DBC) files -* [opendbc/can/](opendbc/can/) is a library for parsing and building CAN messages from DBC files -* [opendbc/car/](opendbc/car/) is a high-level library for interfacing with cars using Python - -## Contributing - -What we're looking for: -* Support for new cars -* Improved support for : longitudinal control -* Tests -* Good examples - -Check out the openpilot contributing guidelines.