Skip to content

Commit cb113d8

Browse files
committed
remove mermaid - use images b/c of doxy
1 parent 0c9c7cd commit cb113d8

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

README.md

+15-8
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ The SparkFun Toolkit provides a single implementation of common functionality us
3333

3434
Implemented using C++, the SparkFun toolkit follows a simple two layered approach in it's design: A core foundational layer, and a platform specific layer.
3535

36-
```mermaid
36+
![Core Architecture](docs/images/rm_img_01.png)
37+
38+
<!-- ```mermaid
3739
---
3840
title: General Architecture Structure
3941
---
@@ -42,9 +44,12 @@ classDiagram
4244
class PlatformOne["Platform Implementation"]
4345
CoreToolkit <|-- PlatformOne
4446
45-
```
46-
And as additional plaforms are added, they also implement/inherit from the SparkFun Toolkit Core.
47-
```mermaid
47+
``` -->
48+
And as additional platforms are added, they also implement/inherit from the SparkFun Toolkit Core.
49+
50+
![Multi-Platform Structure](docs/images/rm_img_02.png)
51+
52+
<!-- ```mermaid
4853
---
4954
title: Multi-Platform Structure
5055
---
@@ -55,11 +60,13 @@ classDiagram
5560
5661
CoreToolkit <|-- PlatformOne
5762
CoreToolkit <|-- PlatformTwo
58-
```
63+
``` -->
5964

6065
When using the SparkFun Toolkit, the intent is for the implementation to follow the same pattern: A platform independent layer that works with the SparkFun Toolkit core, and a platform specific layer that utilizes the SparkFun Toolkit platform specific implementation.
6166

62-
```mermaid
67+
![Application Structure](docs/images/rm_img_03.png)
68+
69+
<!-- ```mermaid
6370
---
6471
title: Application Structure
6572
---
@@ -76,9 +83,9 @@ classDiagram
7683
style PlatformOne fill:#909090
7784
7885
CoreToolkit <|-- PlatformOne
79-
ApplicationCore <--> Application Platform
86+
ApplicationCore <-- > ApplicationPlatform
8087
81-
```
88+
``` -->
8289

8390
If/when the application is moved to another platform, just the platform specific logic needs implementation.
8491

0 commit comments

Comments
 (0)