Skip to content

Commit 3133cf0

Browse files
committed
docs: README flow diagrams
1 parent d045d86 commit 3133cf0

File tree

10 files changed

+28
-3
lines changed

10 files changed

+28
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@
88
} -->
99
<div align="center">
1010

11-
<!-- TODO: Nicer README e.g. image, features, flow diagram, project structure -->
12-
1311
![demo](landing/assets/demo.webp)
1412

1513
# Oko
@@ -80,10 +78,28 @@ For a full list see the [Documents](#documents).
8078
![poster prototype](landing/assets/poster_prototype.webp)
8179
</details>
8280

81+
## Flow Diagrams
82+
83+
| Oko Overview |
84+
|:-------:|
85+
| ![Oko Overview](landing/assets/flow-diagrams/Threads.svg) |
86+
87+
| Account Creation | CI/CD Testing | Settings |
88+
|:----------------:|:-------------:|:--------:|
89+
| ![Account Creation](landing/assets/flow-diagrams/Account_Creation_Flow.svg) | ![CI/CD Testing](landing/assets/flow-diagrams/CICD_Testing.svg) | ![Settings](landing/assets/flow-diagrams/Camera_Settings_Flow.svg) |
90+
91+
| Recording | Camera Detection |
92+
|:----------------:|:-------------:|
93+
| ![Recording](landing/assets/flow-diagrams/Record_Flow.svg) | ![Camera Detection](landing/assets/flow-diagrams/Camera_Detection_Flow.svg) |
94+
95+
| Image Streaming | ESP32-CAM Setup | Permissions |
96+
|:---------------:|:---------------:|:-----------:|
97+
| ![Image Streaming](landing/assets/flow-diagrams/ESP32-CAM_Image_Streaming.svg) | ![Image Streaming](landing/assets/flow-diagrams/ESP32-CAM_Setup.svg) | ![Permissions](landing/assets/flow-diagrams/Permissions_Flow.svg) |
98+
8399
## Notes
84100

85101
| Notes | Demo Notes |
86-
|:------------:|:------:|
102+
|:-----:|:----------:|
87103
| [<img alt="notes" width="800px" src="landing/assets/notes.webp"/>](landing/assets/notes.webp) | [<img alt="demo notes" width="400px" src="landing/assets/demo_notes.webp"/>](landing/assets/demo_notes.webp) |
88104

89105
## License

landing/assets/flow-diagrams/Account_Creation_Flow.svg

Lines changed: 1 addition & 0 deletions
Loading

landing/assets/flow-diagrams/CICD_Testing.svg

Lines changed: 1 addition & 0 deletions
Loading

landing/assets/flow-diagrams/Camera_Detection_Flow.svg

Lines changed: 1 addition & 0 deletions
Loading

landing/assets/flow-diagrams/Camera_Settings_Flow.svg

Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 1 addition & 0 deletions
Loading

landing/assets/flow-diagrams/ESP32-CAM_Setup.svg

Lines changed: 1 addition & 0 deletions
Loading

landing/assets/flow-diagrams/Permissions_Flow.svg

Lines changed: 1 addition & 0 deletions
Loading

landing/assets/flow-diagrams/Record_Flow.svg

Lines changed: 1 addition & 0 deletions
Loading

landing/assets/flow-diagrams/Threads.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)