Skip to content

Commit

Permalink
Updated uml class diagram and README.
Browse files Browse the repository at this point in the history
  • Loading branch information
jo3-tech committed Oct 6, 2024
1 parent 0bdb382 commit 673cb91
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 4 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,17 @@ This project doesn't impose any specific build system, however the preferred met

### External libraries

The following libraries (available via the [Arduino library manager](https://www.arduino.cc/reference/en/libraries/)) are used within the project:
The following libraries (available via the [Arduino library manager](https://www.arduino.cc/reference/en/libraries)) are used within the project:

- [MT-arduino-momentary-button](https://github.com/Morgritech/MT-arduino-momentary-button)
- [MT-arduino-stepper-driver](https://github.com/Morgritech/MT-arduino-stepper-driver)
- [Arduino-Log](https://github.com/thijse/Arduino-Log/)
- [Arduino-Log](https://github.com/thijse/Arduino-Log)

### UML class diagram

The image below shows a high level overview of the system:

![UML class diagram](docs\uml-class-diagram-overview.png)

## Setup and build

Expand Down Expand Up @@ -90,7 +96,7 @@ Replace COM3 in the command with the desired serial port.

**Setup a Linux device ready to build the project.**

In order for Arduino tools to access the ports (e.g., for upload the programme to a board), your username/log-in name must be added to the dialout group:
In order for Arduino tools to access the ports (e.g., to upload the programme to a board), your username/log-in name must be added to the dialout group:

``` shell
sudo usermod -a G dialout username
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@startuml uml class diagram - overview
@startuml
title UML Class Diagram - High Level System Overview

package MTspin-mcu-firmware {
Expand Down

0 comments on commit 673cb91

Please sign in to comment.