Merge pull request #3 from NVIDIA-AI-IOT-private/v0.0.0

V0.0.0

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2019, NVIDIA CORPORATION. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,22 +1,43 @@
 # JetRacer
 
-JetRacer is an educational AI racecar using NVIDIA Jetson Nano that is
+<img src="https://lh3.googleusercontent.com/NKCZUpv25TTaZ4PFVbxIUZkzVP7l90xhGrmiXJo4R6edUQnWp5coYkM7J1T9pZOnHM6KyhmdxXwpsn7or_8r--yNva_fPAdjZnqdNU3_NUSK7iGxqFzQ0Ucjb0F4WucMUg4MRYOJ5so" height=256>
 
-* Affordable - ~$250 including Jetson Nano
+JetRacer is an educational AI racecar using NVIDIA Jetson Nano that is
 
+* Affordable - Less than $400 *including* Jetson Nano
 * Educational - Examples from basic motion to AI road following
 * Fun! - Interactively programmed from your web browser
 
-To get started, check out the [JetRacer Wiki](#).
+To get started, follow the [setup](#setup) below.
 
 ## Setup
 
-1. Follow the [JetCard](#) installation guide
+To get started with JetRacer, follow these steps
+
+1. Order parts from the [bill of materials](docs/bill_of_materials.md)
+
+2. Follow the [hardware setup](docs/hardware_setup.md)
+3. Follow the [software setup](docs/software_setup.md)
+4. Run through the [examples](docs/examples.md)
+
+## Examples
+
+### Example 1 - Basic motion
+
+In this example you'll learn to progam JetRacer programatically from your web browser.  Learn more in the [examples](docs/examples.md) documentation.
+
+<img src="https://user-images.githubusercontent.com/4212806/60383497-68d90a80-9a26-11e9-9a18-778b7d3a3221.gif" height=300/>
+
+### Example 2 - Road following
+
+In this example, you'll teach JetRacer how to follow a road using AI.  After training the neural network using the [interactive training notebook](notebooks/interactive_regression.ipynb), you'll deploy an optimized live demo on JetRacer.  Learn more in the [examples](docs/examples.md).
+
+<img src="https://user-images.githubusercontent.com/4212806/60383389-bd7b8600-9a24-11e9-9f64-926e5edb52cc.gif" height=300/>
+
+## See also
 
-2. Install the JetRacer python package
+* [JetBot](http://github.com/NVIDIA-AI-IOT/jetbot) - An educational AI robot based on NVIDIA Jetson Nano
 
-    ```bash
-    git clone https://github.com/NVIDIA-AI-IOT-private/jetracer.git
-    cd jetracer
-    sudo python3 setup.py install
-    ```
+* [JetCam](http://github.com/NVIDIA-AI-IOT/jetcam) - An easy to use Python camera interface for NVIDIA Jetson
+* [JetCard](http://github.com/NVIDIA-AI-IOT/jetcard) - An SD card image for web programming AI projects with NVIDIA Jetson Nano
+* [torch2trt](http://github.com/NVIDIA-AI-IOT/torch2trt) - An easy to use PyTorch to TensorRT converter