diff --git a/Docs/ProjectOverview.md b/Docs/ProjectOverview.md index 00fcd810..cc77f27a 100644 --- a/Docs/ProjectOverview.md +++ b/Docs/ProjectOverview.md @@ -1,5 +1,19 @@ # Overview +ScreenPlay consists of 5 projects: +1. **ScreenPlay** + * The main ScreenPlay App UI with Create, Installed, Community and Settings +2. **ScreenPlaySDK** + * A SDK used internally in the ScreenPlayWallpaper and ScreenPlayWidget to talk to the main ScreenPlay app via QLocalsockets (Windows Pipes and Unix sockets) +3. **ScreenPlaySysInfo** + * A qml plugin to read CPU, GPU, Network and all sort of statisitcs +4. **ScreenPlayWallpaper** + * The Wallpaper executable that is used for displaying a single wallpaper. This uses ScreenPlaySDK to talk via QLocalsockets with the main ScreenPlayApp. +5. **ScreenPlayWidget** + * The Widget executable that is used for displaying a single widget. This uses ScreenPlaySDK to talk via QLocalsockets with the main ScreenPlayApp . +![ProjectOverview.png](ProjectOverview.png) + +### ScreenPlay classes ``` mermaid graph TD @@ -21,4 +35,4 @@ MonitorListModel --> Monitor App --> ProfileListModel ProfileListModel --> Profile -``` \ No newline at end of file +``` diff --git a/Docs/ProjectOverview.png b/Docs/ProjectOverview.png new file mode 100644 index 00000000..65cdab12 Binary files /dev/null and b/Docs/ProjectOverview.png differ diff --git a/README.md b/README.md index 06eba4b3..3f6fe66b 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,9 @@ Everyone can contribute with code, design, documentation or translation. Visit o # Contributing for programmer * If you want to contribute but don't know how to start, take a look at our open issues and WIP merge request. - * If you need help don't hesitate to ask me (Keltseth) via our forum/discord! + * If you need help don't hesitate to ask me (Keltseth) via: + * [Create a forum topic with a detailed description](https://forum.screen-play.app/category/2/general-discussion) + * [discord channel general](https://discord.gg/3RygPHZ) * [Developer setup guide on how to download and compile ScreenPlay yourself.](Docs/DeveloperSetup.md) * [ScreenPlay project overview](Docs/ProjectOverview.md) * [Developer C++ Classes Documentation](https://kelteseth.gitlab.io/ScreenPlayDeveloperDocs/)