Skip to content

Commit e07c2e9

Browse files
committed
update: add important note about module's name in the project in README.md
1 parent f5a5bf1 commit e07c2e9

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,13 @@ Source/
5151

5252
### Real Project Structure (FirstModule)
5353

54+
> **📝 Important Note:**
55+
> The module names **Auto** and **Manual** in this project are chosen purely to demonstrate two different methods of module creation:
56+
> - **Auto**: Created using IDE (JetBrains Rider) with automatic generation
57+
> - **Manual**: Created manually with full control over the process
58+
>
59+
> These names have **no special meaning** regarding module dependencies or functionality. The same principles apply to any module names (e.g., ModuleA/ModuleB, GameplayCore/UISystem, etc.). The dependency relationship (Manual depends on Auto) is simply for demonstration purposes and could easily be reversed or applied to any other module combination.
60+
5461
```
5562
FirstModule/Source/
5663
├── Auto/ # IDE-created module
@@ -363,6 +370,18 @@ IMPLEMENT_MODULE(FAutoModule, Auto)
363370

364371
## Module Dependencies
365372

373+
> **📝 Naming Convention Note:**
374+
> In this project, "Manual depends on Auto" is purely for demonstration. The dependency direction has nothing to do with how the modules were created (manually vs IDE). In real projects, you might have:
375+
> - `GameplayCore` depends on `UtilityLibrary`
376+
> - `UISystem` depends on `GameplayCore`
377+
> - `AudioManager` depends on `ConfigurationModule`
378+
> - `PlayerController` depends on `InputManager`
379+
>
380+
> The dependency direction and module names should reflect your actual project architecture, not the creation method. You could equally have:
381+
> - Auto depends on Manual
382+
> - ModuleA depends on ModuleB
383+
> - Any meaningful combination based on your project needs
384+
366385
### Manual Module Depends on Auto Module
367386

368387
**Manual.Build.cs shows the dependency:**

0 commit comments

Comments
 (0)