README.md 1.03 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:
Will Roscoe's avatar
Will Roscoe committed
* quickly [build your own self driving RC Car](docs/get_started.md) with a Raspbery Pi.
Will Roscoe's avatar
Will Roscoe committed
* test out your self driving idea 
Will Roscoe's avatar
Will Roscoe committed

Will Roscoe's avatar
Will Roscoe committed

Will Roscoe's avatar
Will Roscoe committed
Guiding Principles
* **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. 

*** These guidelines are nearly copied from Keras because they are so good *** 



## 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