Skip to content

Commit 659023f

Browse files
committed
Fixed ReadMe
1 parent 6f49e5a commit 659023f

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

README.md

+28-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,28 @@
1-
# ros-2torials
2-
For learning ROS 2!
1+
# tutorials
2+
This package is for learning ROS 2 and can be combined with the Nuclino documentation. :notebook:
3+
4+
### Script Conversion Task
5+
One of the first programs everyone on the software team has to do, prior to converting their first real script, is to convert the **heartbeat_sub.py** script. The original script can be found on GitHub in the **rover** repository [here](https://github.com/novarover/rover/blob/master/scripts/heartbeat_listener.py).
6+
7+
Here is the process you will need to follow:
8+
9+
1. Install this repository into the source folder of your current ROS 2 workspace. This can be a new one or an old one. :package:
10+
11+
2. Create a new branch called [name]. For example, you could call it *harrison* if you were me (I wonder who wrote this...).
12+
13+
3. Read through the previous script, understand what it does and the functionality it must provide. :scroll:
14+
15+
4. Create a new script in the new repository (in this case, this one) and set it to the correct name as per the naming conventions.
16+
17+
5. Replicate the script by programming the functionality using ROS 2, Python 3 and classes. Make sure all PEP8 coding conventions are followed. They can be found on [Nuclino](https://app.nuclino.com/Nova-Rover-Team/Software-2021/Python-1241f1a3-a1ee-45aa-8b68-e0f9e0d1b6ad). :snake:
18+
19+
6. Make sure it works as expected using the command line ROS interface. You do not need to turn this into a launch file; simply running the following line is sufficient:
20+
21+
`python3 [file].py`
22+
23+
7. Once happy with it working, add all your changes to GitHub on your current branch and make a **pull request** to the **master** branch. Make sure to add both Liam Whittle and Harrison Verrios to the pull request. Do not click merge.
24+
25+
8. The two software STRs will then look through your code and provide feedback. :rocket:
26+
27+
28+
If you have any questions at all, please do not hesistate to contact us and ask away! That is what the #software Slack channel is for. :)

0 commit comments

Comments
 (0)