Move examples and update README.md

- Move all examples into an examples directory. - Add simple instructions to README.md - Remove all videos (put output video on YouTube)
evenator · Aug 3, 2017 · dadb5f3 · dadb5f3
1 parent fa3bf2a
commit dadb5f3
Show file tree

Hide file tree

Showing 53 changed files with 31 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -21,6 +21,36 @@ general process for this project is as follows:
   image, as well as a numerical estimate of the lane curvature and vehicle
   position.
 
+Installing This Package
+-----------------------
+
+You can install this package (and all its dependencies) with `pip`:
+
+```bash
+pip install git+https://github.com/evenator/CarND-Advanced-Lane-Lines.git
+```
+
+Using This Package
+------------------
+
+First, you'll need to calibrate your camera to correct for lens distortion. Create a directory of
+checkerboard images like the images in `examples/camera_cal_images/`. Then, use the
+`calibrate_camera` script to generate calibration parameters, which will be saved as numpy files.
+You can get help with `calibrate_camera --help`
+
+Next, you'll need to calibrate the perspective transform from your camera to the ground. For this,
+you'll need to mount the camera in the vehicle and take an image of very large rectangle of known
+size on the ground in front of the vehicle. Dashed lane markers on a straight road work well for
+this. Run `calculate_perspective` and follow the directions to create a projector, which is saved
+as a Python pickle file. `calculate_perspective` is interactive and should be relatively intuitive.
+
+Finally, you can use the camera calibration data and projector you created to process images and
+video with `find_lanelines`. You can get help with `find_lanelines --help`.
+
+Of course, you can also use the classes and methods defined here in your own Python programs. The
+modules in the `lanelines` package are all documented to make them as easy to use as possible. In
+the future, I'll publish this documentation with Sphinx.
+
 Camera Calibration and Distortion Correction
 --------------------------------------------
 
@@ -174,7 +204,7 @@ The other test images can be found in the `output_images` directory as well.
 Video Pipeline
 --------------
 
-The output of the video pipeline can be found [here](project_video_out.mp4).
+The output of the video pipeline can be found [here](https://youtu.be/A8eEAL4L25s).
 
 The video pipeline has a few differences from the single-image pipeline. All of
 these differences are based on the concept of persisting the lane line estimate

diff --git a/challenge_video.mp4 b/challenge_video.mp4
diff --git a/challenge_video_out.mp4 b/challenge_video_out.mp4
diff --git a/camera_cal/calibration1.jpg → examples/camera_cal_images/calibration1.jpg b/camera_cal/calibration1.jpg → examples/camera_cal_images/calibration1.jpg
diff --git a/camera_cal/calibration10.jpg → examples/camera_cal_images/calibration10.jpg b/camera_cal/calibration10.jpg → examples/camera_cal_images/calibration10.jpg
diff --git a/camera_cal/calibration11.jpg → examples/camera_cal_images/calibration11.jpg b/camera_cal/calibration11.jpg → examples/camera_cal_images/calibration11.jpg
diff --git a/camera_cal/calibration12.jpg → examples/camera_cal_images/calibration12.jpg b/camera_cal/calibration12.jpg → examples/camera_cal_images/calibration12.jpg
diff --git a/camera_cal/calibration13.jpg → examples/camera_cal_images/calibration13.jpg b/camera_cal/calibration13.jpg → examples/camera_cal_images/calibration13.jpg
diff --git a/camera_cal/calibration14.jpg → examples/camera_cal_images/calibration14.jpg b/camera_cal/calibration14.jpg → examples/camera_cal_images/calibration14.jpg
diff --git a/camera_cal/calibration15.jpg → examples/camera_cal_images/calibration15.jpg b/camera_cal/calibration15.jpg → examples/camera_cal_images/calibration15.jpg
diff --git a/camera_cal/calibration16.jpg → examples/camera_cal_images/calibration16.jpg b/camera_cal/calibration16.jpg → examples/camera_cal_images/calibration16.jpg
diff --git a/camera_cal/calibration17.jpg → examples/camera_cal_images/calibration17.jpg b/camera_cal/calibration17.jpg → examples/camera_cal_images/calibration17.jpg
diff --git a/camera_cal/calibration18.jpg → examples/camera_cal_images/calibration18.jpg b/camera_cal/calibration18.jpg → examples/camera_cal_images/calibration18.jpg
diff --git a/camera_cal/calibration19.jpg → examples/camera_cal_images/calibration19.jpg b/camera_cal/calibration19.jpg → examples/camera_cal_images/calibration19.jpg
diff --git a/camera_cal/calibration2.jpg → examples/camera_cal_images/calibration2.jpg b/camera_cal/calibration2.jpg → examples/camera_cal_images/calibration2.jpg
diff --git a/camera_cal/calibration20.jpg → examples/camera_cal_images/calibration20.jpg b/camera_cal/calibration20.jpg → examples/camera_cal_images/calibration20.jpg
diff --git a/camera_cal/calibration3.jpg → examples/camera_cal_images/calibration3.jpg b/camera_cal/calibration3.jpg → examples/camera_cal_images/calibration3.jpg
diff --git a/camera_cal/calibration4.jpg → examples/camera_cal_images/calibration4.jpg b/camera_cal/calibration4.jpg → examples/camera_cal_images/calibration4.jpg
diff --git a/camera_cal/calibration5.jpg → examples/camera_cal_images/calibration5.jpg b/camera_cal/calibration5.jpg → examples/camera_cal_images/calibration5.jpg
diff --git a/camera_cal/calibration6.jpg → examples/camera_cal_images/calibration6.jpg b/camera_cal/calibration6.jpg → examples/camera_cal_images/calibration6.jpg
diff --git a/camera_cal/calibration7.jpg → examples/camera_cal_images/calibration7.jpg b/camera_cal/calibration7.jpg → examples/camera_cal_images/calibration7.jpg
diff --git a/camera_cal/calibration8.jpg → examples/camera_cal_images/calibration8.jpg b/camera_cal/calibration8.jpg → examples/camera_cal_images/calibration8.jpg
diff --git a/camera_cal/calibration9.jpg → examples/camera_cal_images/calibration9.jpg b/camera_cal/calibration9.jpg → examples/camera_cal_images/calibration9.jpg
diff --git a/examples/camera_matrix.npy b/examples/camera_matrix.npy
diff --git a/examples/distortion_coefficients.npy b/examples/distortion_coefficients.npy
diff --git a/output_images/.DS_Store → examples/output_images/.DS_Store b/output_images/.DS_Store → examples/output_images/.DS_Store
diff --git a/output_images/binary_lane_extraction.png → .../output_images/binary_lane_extraction.png b/output_images/binary_lane_extraction.png → .../output_images/binary_lane_extraction.png
diff --git a/output_images/checkerboard.png → examples/output_images/checkerboard.png b/output_images/checkerboard.png → examples/output_images/checkerboard.png
diff --git a/output_images/fit.png → examples/output_images/fit.png b/output_images/fit.png → examples/output_images/fit.png
diff --git a/output_images/perspective.png → examples/output_images/perspective.png b/output_images/perspective.png → examples/output_images/perspective.png
diff --git a/output_images/save_output_here.txt → examples/output_images/save_output_here.txt b/output_images/save_output_here.txt → examples/output_images/save_output_here.txt
diff --git a/output_images/straight_lines1.jpg → examples/output_images/straight_lines1.jpg b/output_images/straight_lines1.jpg → examples/output_images/straight_lines1.jpg
diff --git a/output_images/straight_lines2.jpg → examples/output_images/straight_lines2.jpg b/output_images/straight_lines2.jpg → examples/output_images/straight_lines2.jpg
diff --git a/output_images/test1.jpg → examples/output_images/test1.jpg b/output_images/test1.jpg → examples/output_images/test1.jpg
diff --git a/output_images/test2.jpg → examples/output_images/test2.jpg b/output_images/test2.jpg → examples/output_images/test2.jpg
diff --git a/output_images/test3.jpg → examples/output_images/test3.jpg b/output_images/test3.jpg → examples/output_images/test3.jpg
diff --git a/output_images/test4.jpg → examples/output_images/test4.jpg b/output_images/test4.jpg → examples/output_images/test4.jpg
diff --git a/output_images/test5.jpg → examples/output_images/test5.jpg b/output_images/test5.jpg → examples/output_images/test5.jpg
diff --git a/output_images/test6.jpg → examples/output_images/test6.jpg b/output_images/test6.jpg → examples/output_images/test6.jpg
diff --git a/output_images/transformed_binary.png → ...ples/output_images/transformed_binary.png b/output_images/transformed_binary.png → ...ples/output_images/transformed_binary.png
diff --git a/output_images/undistorted.png → examples/output_images/undistorted.png b/output_images/undistorted.png → examples/output_images/undistorted.png
diff --git a/projector.p → examples/projector.p b/projector.p → examples/projector.p
diff --git a/test_images/straight_lines1.jpg → examples/test_images/straight_lines1.jpg b/test_images/straight_lines1.jpg → examples/test_images/straight_lines1.jpg
diff --git a/test_images/straight_lines2.jpg → examples/test_images/straight_lines2.jpg b/test_images/straight_lines2.jpg → examples/test_images/straight_lines2.jpg
diff --git a/test_images/test1.jpg → examples/test_images/test1.jpg b/test_images/test1.jpg → examples/test_images/test1.jpg
diff --git a/test_images/test2.jpg → examples/test_images/test2.jpg b/test_images/test2.jpg → examples/test_images/test2.jpg
diff --git a/test_images/test3.jpg → examples/test_images/test3.jpg b/test_images/test3.jpg → examples/test_images/test3.jpg
diff --git a/test_images/test4.jpg → examples/test_images/test4.jpg b/test_images/test4.jpg → examples/test_images/test4.jpg
diff --git a/test_images/test5.jpg → examples/test_images/test5.jpg b/test_images/test5.jpg → examples/test_images/test5.jpg
diff --git a/test_images/test6.jpg → examples/test_images/test6.jpg b/test_images/test6.jpg → examples/test_images/test6.jpg
diff --git a/harder_challenge_video.mp4 b/harder_challenge_video.mp4
diff --git a/project_video.mp4 b/project_video.mp4
diff --git a/project_video_out.mp4 b/project_video_out.mp4