Skip to content

Commit

Permalink
Update README.md to polish
Browse files Browse the repository at this point in the history
  • Loading branch information
AniMB authored Sep 27, 2024
1 parent 8af75fe commit 4b4b883
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Hardware-in-loop
Hardware in loop allows remote uploading of code onto STM32 boads without physical presence near the boards.
Hardware in loop allows remote code uploading onto STM32 boards without physical presence near the boards.

## Mission
This project uses a Raspberry Pi as a hub to remotely pull code from github and upload code to the STM32 board. The aim is to facilitate rapid development of code.
This project uses a Raspberry Pi as a hub to remotely pull code from Git Hub and upload code to the STM32 board. The aim is to facilitate the rapid development of code.

## Requirements
1. An STM32 board
2. A Raspberry Pi
3. Github Actions Runner
This can be setup by going to the setting -> actions -> runner as setup a linux runner. Follow the commands '''**except the last command**'''.
This can be set up by going to the settings -> actions -> runner and setting up a Linux runner. Follow all the commands '''**except the last command**''' which executes the `run.sh` shell script.
4. Libraries
- Setting up printf and scanf using this [website](https://shawnhymel.com/1873/how-to-use-printf-on-stm32/)
- Installing OpenOCD using the code below
Expand All @@ -33,12 +33,12 @@ This can be setup by going to the setting -> actions -> runner as setup a linux
sudo apt-get install stlink-tools
```
## Execution
The worklfow on the yaml file starts the moment a push is made to main.
Add the `file paths` to the YAML file.
The worklfow on the yaml file starts when a push is made to main.
Add the `file paths` to the YAML file. These `file paths` are labelled in the `env` section of the YAML file.
To execute this project to the location of the self hosted runner loaction and execute `./run/sh`.
## Precautions
Incase the runner is deleted, reinstall the runner at the same location. To do this, skip the `first command`.
In case the runner is deleted, please go ahead and reinstall the runner at the same location (which by default shall be actions-runner). To do this, **skip** the `first command` (`*mkdir.....*`) .
If you get an error while configuring, execute
```
ls -a
Expand Down

0 comments on commit 4b4b883

Please sign in to comment.