Mirrors/ScreenPlay
Mirrors/ScreenPlay
1
0
Fork 0
mirror of https://gitlab.com/kelteseth/ScreenPlay.git synced 2024-11-04 18:12:35 +01:00
Code Issues Projects Releases Activity

Add more docs

Browse Source
This commit is contained in:
Elias Steurer 2020-05-16 14:30:11 +02:00
parent 4d9f95d1aa
commit 8747280d39
3 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Docs/ProjectOverview.md
View File

@ -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
```
```

BIN
Docs/ProjectOverview.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 118 KiB

4
README.md
View File

@ -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/)