This document (README_template.md) provides a template for your final documentation (NOT YOUR PROPOSAL).
- Your final document should be named simply
README.md. - I've left several comments below. These should obviously be removed from your document.
- You may add additional sections as you see fit, but you should not remove any of the sections defined below.
- Please keep in mind that the audience for this document should be students in the Fall 2022 section of this class. (In other words, write this such that 3-month-younger you would've been able to utilize this document.)
Project Name: [provide catkin_ws name here].
For example, followbot, wanderbot, and teleopbot are project names we've used in class. When I install your code, I want to know where I'll find it in ~/catkin_ws/src/
Team Members:
- [Member 1, email]
- [Member 2, email]
In this section, describe what your project does. This should be descriptive. Someone from next year's class should be able to fully understand the aims and scope of your project. I highly recommend using pictures to help explain things. Maybe even post a YouTube video showing your code in action.
NOTE: This is not a proposal. This is a final report describing your actual completed project.
In this subsection, I want to know what is new/unique/interesting about your project.
In this section you should provide instructions for someone else to install all of the code necessary to execute your project. Your target audience should be a student from this semester's class. You may assume that the student has ROS Noetic installed on Ubuntu 20.04.
List of Prerequisite Software:
- [software 1]
- [software 2]
- [etc.] This is just a list, not installation instructions. The idea is to provide a summary of the additional software/packages that need to be installed. Instructions go below.
Now, provide detailed step-by-step instructions to install all necessary software for your project.
The expectation is that the user should only have to follow these steps one time. For example, if your project requires generating Gazebo mazes, the task of INSTALLING the maze generation code should go in this section.
Provide detailed step-by-step instructions to run your code.
NOTE: At this point, the user should have already installed the necessary code. This section should simply describe the steps for RUNNING your project.
You have already defined these measures of success (MoS) in your proposal, and updated them after your progress report. The purpose of this section is to highlight how well you did. Also, these MoS will be useful in assigning partial credit.
The MoS summary should be in table form. A sample is provided below:
| Measure of Success (from your PROPOSAL) | Status (completion percentage) |
|---|---|
| Install PR2 ROS Indigo Package | 100% |
| Write brain reader software to move the robot | 25% (brain reader software detects brain waves, but does not translate to ROS commands.) |
NOTE 1: I have your proposals...don't move the goal posts!
NOTE 2: For activities less than 100% complete, you should differentiate between what you completed and what you were unable to complete. I suggest you add details in a bullet list below.
For example, what concepts from class do you now have a solid understanding of? What new techniques did you learn?
Also, what challenges did you face, and how did you overcome these? Be specific.
If a student from next year's class wants to build upon your project, what would you suggest they do? What suggestions do you have to help get them started (e.g., are there particular Websites they should check out?).
What resources did you use to help finish this project?
- Include links to Websites. Explain what this Website enabled you to accomplish.
- Include references to particular chapters/pages from the ROS book. Why was each chapter necessary/helpful?