Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
adeebshihadeh committed Aug 17, 2024
1 parent bfa1726 commit 7557fe5
Showing 1 changed file with 6 additions and 17 deletions.
23 changes: 6 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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.

0 comments on commit 7557fe5

Please sign in to comment.