From 4592e011d6057eff0431aa36d794a52832ad3f9a Mon Sep 17 00:00:00 2001 From: Nitwel Date: Sun, 5 Nov 2023 15:27:57 +0100 Subject: [PATCH] add file structure to readme --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 84d2e27..6909195 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,20 @@ Communication with the Smart Home Environment is done using the `HomeAdapters` g A device is a collection of different entities and entities can represent many different things in a smart home. For example, the entity of name `lights.smart_lamp_1` would control the kitchen lamps while `state.smart_lamp_1_temp` would show the current temperature of the lamp. +### File Structure + +``` +. +├── addons (All installed Godot Addons are saved here) +├── assets (Files like logos or assets that are shared across scenes) +├── content (Main files of the project)/ +│ ├── entities (Entities that can be placed into the room) +│ └── ui (User Interface Scenes and related files) +└── lib (Code that is global or shared across scenes)/ + ├── globals (Globally running scripts) + └── home_adapters (Code allowing control smart home entities) +``` + ### Home Adapters The `HomeAdapters` global allows to communicate with different backends and offers a set of fundamental functions allowing communication with the Smart Home.