README.md 1.16 KB
Newer Older
Will Roscoe's avatar
Will Roscoe committed
![travis](https://travis-ci.org/wroscoe/donkey.svg?branch=dev)
Will Roscoe's avatar
Will Roscoe committed

Will Roscoe's avatar
Will Roscoe committed
# Donkey: a python self driving library 
Will Roscoe's avatar
Will Roscoe committed

Will Roscoe's avatar
Will Roscoe committed
Donkey is minimalist and modular self driving library written in Python. It is 
developed for hobbiests with a focus on allowing fast experimentation and easy 
community contributions.  
Will Roscoe's avatar
Will Roscoe committed

Will Roscoe's avatar
Will Roscoe committed
[Documentation](http://docs.donkeycar.com)

#### Build the standard [Donkey2](http://www.donkeycar.com) ($200 + 2 hours)
Will Roscoe's avatar
Will Roscoe committed

#### Use Donkey if you want to:
Will Roscoe's avatar
Will Roscoe committed
* Make an RC car drive its self.
* Compete in self driving races like [DIY Robocars](diyrobocars.com)
Will Roscoe's avatar
Will Roscoe committed
* Experiment with different driving methods.
* Add parts and sensors to your car.
Will Roscoe's avatar
Will Roscoe committed

Will Roscoe's avatar
Will Roscoe committed
#### Features:
Will Roscoe's avatar
Will Roscoe committed
* Data logging. (images, user inputs, sensor readings) 
* Web or hardware car controls.
* Library of parts and pilots.
* Community contributed driving data.
Will Roscoe's avatar
Will Roscoe committed
* Hardware CAD designs for optional upgrades.

Will Roscoe's avatar
Will Roscoe committed
### Getting started. 
Will Roscoe's avatar
Will Roscoe committed
After building your Donkey2 you can install donkeycar and start driving 
Will Roscoe's avatar
Will Roscoe committed
with your phone by running the following via ssh on the cars Raspberry Pi. 
Will Roscoe's avatar
Will Roscoe committed
```
Will Roscoe's avatar
Will Roscoe committed
pip install donkeycar

donkey createcar --path ~/d2

python car.py drive
Will Roscoe's avatar
Will Roscoe committed
```
Now you can control your car by going to `<ip_address_of_your_pi>:8887/drive`