Skip to content

Commit 45b8a08

Browse files
committed
Table of contents.
1 parent 0248f15 commit 45b8a08

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,22 @@
44
[![Format](https://github.com/kineticsystem/stepit/actions/workflows/ci-format.yml/badge.svg)](https://github.com/kineticsystem/stepit/actions/workflows/ci-format.yml)
55
[![Linters](https://github.com/kineticsystem/stepit/actions/workflows/ci-ros-lint.yml/badge.svg)](https://github.com/kineticsystem/stepit/actions/workflows/ci-ros-lint.yml)
66

7+
8+
## Table of Contents
9+
10+
- [Table of Contents](#table-of-contents)
11+
- [Introduction](#introduction)
12+
- [Prerequisites](#prerequisites)
13+
- [Install StepIt on the Microcontroller](#install-stepit-on-the-microcontroller)
14+
- [Install StepIt on the Local Computer](#install-stepit-on-the-local-computer)
15+
- [Setup a Project Workspace](#setup-a-project-workspace)
16+
- [Chekout the Git Repository](#chekout-the-git-repository)
17+
- [Pre-Commit Hooks](#pre-commit-hooks)
18+
- [Build the Project](#build-the-project)
19+
- [Running the Application](#running-the-application)
20+
- [How to run GitHub Actions locally](#how-to-run-github-actions-locally)
21+
22+
723
## Introduction
824

925
StepIt is a project to control stepper motors with a Teensy microcontroller and ROS2.
@@ -24,17 +40,17 @@ For a real application, we recommend attaching the stepper motors to a Teensy mi
2440

2541
The Teensy is connected to a computer using a USB cable. For a portable application, we can use a [Raspberry PI 4](docs/install_ros_on_rasperry_pi/install_ros2_on_rasperry_pi.md).
2642

27-
## Install StepIt on the microcontroller
43+
## Install StepIt on the Microcontroller
2844

2945
We developed code for the Teensy microcontroller using Visual Studio Code because it provides very good tools to format and validate the code. To achieve this goal, we must install [PlatformIO](https://platformio.org) extension which supports different microcontrollers including Arduino. Installing Arduino IDE is not required.
3046

3147
If PlatformIO cannot find the Python interpreter, install the following:
3248

3349
`sudo apt install python3-venv`
3450

35-
## Install StepIt on the local computer
51+
## Install StepIt on the Local Computer
3652

37-
### Setup a project workspace
53+
### Setup a Project Workspace
3854

3955
Open a terminal and run the following command to source the ROS 2 Humble installation.
4056

@@ -52,7 +68,7 @@ mkdir stepit_ws
5268
cd stepit_ws
5369
```
5470

55-
### Chekout the git repository
71+
### Chekout the Git Repository
5672

5773
Create a source folder and check out this git repository, including all required submodules.
5874

@@ -75,15 +91,15 @@ Remember to enable recursion for relevant git commands, such that regular comman
7591
git config --global submodule.recurse true
7692
```
7793

78-
### Pre-commit hooks
94+
### Pre-Commit Hooks
7995

8096
Additionally, you should install git pre-commit hooks using the following command:
8197

8298
```
8399
pre-commit install
84100
```
85101

86-
### Build the project
102+
### Build the Project
87103

88104
Move into the base `<STEPIT_WS>` folder and install all required dependencies.
89105

@@ -104,7 +120,7 @@ Execute all tests.
104120
colcon test
105121
```
106122

107-
## Running the application
123+
## Running the Application
108124

109125
By default, the application runs with fake motors. Run the following commands on a terminal to start it up. This will also start up RViz.
110126

@@ -185,7 +201,7 @@ ros2 topic pub -1 /joint_trajectory_controller/joint_trajectory trajectory_msgs/
185201

186202
The trajectory is a list of waypoints, each of them containing the desired position and velocity of each joint at a given time.
187203

188-
## How to run GitHub actions locally
204+
## How to run GitHub Actions locally
189205

190206
At each commit, the GitHub repository runs all available tests using [GitHub actions](https://docs.github.com/en/actions) and [Industrial CI](https://github.com/ros-industrial/industrial_ci).
191207

0 commit comments

Comments
 (0)