Update the IntermediatePy project diagram

EasyScience · Aug 30, 2024 · 2fc57bc · 2fc57bc
1 parent 45f2ece
commit 2fc57bc
Showing 1 changed file with 41 additions and 42 deletions.
diff --git a/examples/IntermediatePy/README.md b/examples/IntermediatePy/README.md
@@ -9,49 +9,48 @@
 ├── README.md                               # Current file that introduces and explains a project
 │
 └── 🗂️ src                                  # Source code
-    ├── 🗂️ IntermediatePy                   # Directory with the name of the current Python package
-    │   ├── __init__.py                     # Executed when the current Python package is imported       
-    │   ├── main.qml                        # Root QML component        
-    │   ├── main.py                         # Root Python file      
-    │   │
-    │   ├── 🗂️ Logic                        # Backend logic
-    │   │   ├── 🗂️ Mock                     # Mock logic to be used if no python logic is defined
-    │   │   │   ├── qmldir                  
-    │   │   │   ├── BackendWrapper.qml        # Parent object for all other objects with mock logic
-    │   │   │   ├── Status.qml              # Mock logic for the status bar
-    │   │   │   ├── Project.qml             # Mock logic for the application page 'Project'
-    │   │   │   └── Report.qml              # Mock logic for the application page 'Report'
-    │   │   │
-    │   │   └── 🗂️ Py                       # Backend Python logic
-    │   │       ├── backend_proxy.py        # Parent object for all other objects with logic
-    │   │       ├── helpers.py              # Some helper functions
-    │   │       ├── connections.py          # Connections handling
-    │   │       ├── status.py               # Logic for the status bar
-    │   │       ├── project.py              # Logic for the application page 'Project'
-    │   │       └── report.py               # Logic for the application page 'Report'
-    │   │
-    │   └── 🗂️ Gui                          # Frontend GUI components
-    │       ├── qmldir                      
-    │       ├── ApplicationWindow.qml       # Top-level application window
-    │       ├── StatusBar.qml               # Status bar    
-    │       │
-    │       ├── 🗂️ Globals                  # Globally accessible objects
-    │       │   ├── qmldir                  
-    │       │   ├── ApplicationInfo.qml     
-    │       │   ├── BackendWrapper.qml        # Layer between the backend proxy and GUI objects
-    │       │   └── References.qml          # QML object ids to globally access the desired objects
-    │       │
-    │   (*) ├── 🗂️ Pages                    # Application pages
-    │       │   ├── 🗂️ Home                 # Components of the application page 'Home'
-    │       │   ├── 🗂️ Project              # Components of the application page 'Project'
-    │       │   └── 🗂️ Report               # Components of the application page 'Report'
-    │       │    
-    │       └── 🗂️ Resources
-    │           └── 🗂️ Logos                # Logos of the application and contributors
-    │
     ├── IntermediatePy.qmlproject           # QML project for the Qt Creator IDE
-    └── IntermediatePy.pyproject            # Python project for the Qt Creator IDE
-
+    ├── IntermediatePy.pyproject            # Python project for the Qt Creator IDE
+    │
+    └── 🗂️ IntermediatePy                   # Directory with the name of the current Python package
+        ├── __init__.py                     # Executed when the current Python package is imported       
+        ├── main.qml                        # Root QML component        
+        ├── main.py                         # Root Python file      
+        │
+        ├── 🗂️ Backends                     # Backend logic
+        │   ├── MockBackend.qml             # Parent object for all other objects with mock QML logic
+        │   ├── real_backend.py             # Parent object for all other objects with real python logic
+        │   │
+        │   ├── 🗂️ MockQml                  # Mock QML backend to be used if no python backend is defined
+        │   │   ├── qmldir                  
+        │   │   ├── Status.qml              # Mock logic for the status bar
+        │   │   ├── Project.qml             # Mock logic for the application page 'Project'
+        │   │   └── Report.qml              # Mock logic for the application page 'Report'
+        │   │
+        │   └── 🗂️ real_py                  # Real Python backend
+        │       ├── helpers.py              # Some helper functions
+        │       ├── status.py               # Logic for the status bar
+        │       ├── project.py              # Logic for the application page 'Project'
+        │       └── report.py               # Logic for the application page 'Report'
+        │
+        └── 🗂️ Gui                          # Frontend GUI components
+            ├── qmldir                      
+            ├── ApplicationWindow.qml       # Top-level application window
+            ├── StatusBar.qml               # Status bar    
+            │
+            ├── 🗂️ Globals                  # Globally accessible objects
+            │   ├── qmldir                  
+            │   ├── ApplicationInfo.qml     # Name, version and other information about the application
+            │   ├── BackendWrapper.qml      # Layer between the backend proxy and GUI objects
+            │   └── References.qml          # QML object ids to globally access the desired objects
+            │
+        (*) ├── 🗂️ Pages                    # Application pages
+            │   ├── 🗂️ Home                 # Components of the application page 'Home'
+            │   ├── 🗂️ Project              # Components of the application page 'Project'
+            │   └── 🗂️ Report               # Components of the application page 'Report'
+            │    
+            └── 🗂️ Resources
+                └── 🗂️ Logos                # Logos of the application and contributors 
 
 (*) Full structure of the 'Pages' directory is shown below   
 ```