Skip to content

Commit 0ec8367

Browse files
committed
commenting out mermaid is a fail - need to fully remove for doxy
1 parent cb113d8 commit 0ec8367

File tree

1 file changed

+0
-44
lines changed

1 file changed

+0
-44
lines changed

README.md

-44
Original file line numberDiff line numberDiff line change
@@ -35,58 +35,14 @@ Implemented using C++, the SparkFun toolkit follows a simple two layered approac
3535

3636
![Core Architecture](docs/images/rm_img_01.png)
3737

38-
<!-- ```mermaid
39-
---
40-
title: General Architecture Structure
41-
---
42-
classDiagram
43-
class CoreToolkit["Core Toolkit Interfaces"]
44-
class PlatformOne["Platform Implementation"]
45-
CoreToolkit <|-- PlatformOne
46-
47-
``` -->
4838
And as additional platforms are added, they also implement/inherit from the SparkFun Toolkit Core.
4939

5040
![Multi-Platform Structure](docs/images/rm_img_02.png)
5141

52-
<!-- ```mermaid
53-
---
54-
title: Multi-Platform Structure
55-
---
56-
classDiagram
57-
class CoreToolkit["Core Toolkit Interfaces"]
58-
class PlatformOne["Platform One"]
59-
class PlatformTwo["Platform Two"]
60-
61-
CoreToolkit <|-- PlatformOne
62-
CoreToolkit <|-- PlatformTwo
63-
``` -->
64-
6542
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.
6643

6744
![Application Structure](docs/images/rm_img_03.png)
6845

69-
<!-- ```mermaid
70-
---
71-
title: Application Structure
72-
---
73-
classDiagram
74-
direction TD
75-
note for ApplicationCore "Application Logic"
76-
class ApplicationCore["Application Core"]
77-
class CoreToolkit["Core Toolkit Interfaces"]
78-
79-
note for CoreToolkit "SparkFun Toolkit"
80-
class ApplicationPlatform["Application Platform"]
81-
style ApplicationPlatform fill:#909090
82-
class PlatformOne["Platform Implementation"]
83-
style PlatformOne fill:#909090
84-
85-
CoreToolkit <|-- PlatformOne
86-
ApplicationCore <-- > ApplicationPlatform
87-
88-
``` -->
89-
9046
If/when the application is moved to another platform, just the platform specific logic needs implementation.
9147

9248
## Documentation

0 commit comments

Comments
 (0)