Added basic architecture

pesos · Aug 7, 2020 · 1b836fa · 1b836fa
1 parent f0a1991
commit 1b836fa
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md
@@ -0,0 +1,14 @@
+# Project Architecture
+
+## Brief Overview
+
+![rshark_architecture](images/rshark_arch.png)
+
+## Legend Description
+
+* **Executable:** The binary generated from the source code.
+* **Function:** Same old function that we all know.
+* **Concurrent Function:** A plain function that runs concurrently on a separate thread.
+* **Concurrent Memory Access:** Accessing a shared data structure concurrently.
+* **Concurrent Function Call:** Calling a function on a separate thread.
+* **Concurrently Shared Data Structure:** A thread-safe data structure that is accessed by multiple threads.
diff --git a/images/rshark_arch.png b/images/rshark_arch.png