README.md 1.11 KB
Newer Older
Will Roscoe's avatar
Will Roscoe committed
# Donkey: a self driving library for small scale DIY vehicles. 
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 with a focus on being a toolbox to allowing fast experimentation for any hobbiest. 
Will Roscoe's avatar
Will Roscoe committed

Will Roscoe's avatar
Will Roscoe committed
####Use Donkey if you want to:
* quickly [build your own self driving RC Car](docs/01-build_a_car.md) with a Raspbery Pi.
* use proven algorithms to drive your car. 
* test out your self driving idea against established methods 
Will Roscoe's avatar
Will Roscoe committed

Will Roscoe's avatar
Will Roscoe committed

Will Roscoe's avatar
Will Roscoe committed
###Guiding Principles
Will Roscoe's avatar
Will Roscoe committed
* **Modularity**: A self driving system is composed of standalone, independently configurable modules that can be connected modules.
Will Roscoe's avatar
Will Roscoe committed

Will Roscoe's avatar
Will Roscoe committed
* **Minimalism**: Each component should be kept short (<100 lines of code). Each peice of code should be transparent apon first reading. No black magic, it slows the speed of innovation. 
Will Roscoe's avatar
Will Roscoe committed
* **Extensiblity**: New components should be simple to create by following a template. 

* **Python**: Keep it simple. 

Will Roscoe's avatar
Will Roscoe committed
***These guidelines are nearly copied from Keras because they are so good*** 
Will Roscoe's avatar
Will Roscoe committed
### Get started.
Will Roscoe's avatar
Will Roscoe committed
Once you have built your car see the [demos](demos) to see how to use the Donkey Library: 
 
Will Roscoe's avatar
Will Roscoe committed