Mirrors/ScreenPlay
Mirrors/ScreenPlay
1
0
Fork 0
mirror of https://gitlab.com/kelteseth/ScreenPlay.git synced 2024-09-15 06:52:34 +02:00
Code Issues Projects Releases Activity

Update README.md

Browse Source
This commit is contained in:
Elias Steurer 2020-12-22 15:24:36 +00:00
parent 27d4ee0aef
commit 19b94b1984
1 changed files with 29 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -20,34 +20,49 @@ ScreenPlay is an open source cross platform app for displaying Video Wallpaper,
<h3><a href="https://screen-play.app/">Homepage</a> - <a href="https://forum.screen-play.app/">Forum</a> - <a href="https://discord.gg/3RygPHZ">🎉 Discord (Free Steam Key Here!)</a> - <a href="https://www.reddit.com/r/ScreenPlayApp/">Reddit</a> - <a href="https://store.steampowered.com/app/672870/ScreenPlay/">Steam</a></h3>
<br>
<a href="https://www.youtube.com/watch?v=q-J2fTWDxw8">
![Preview](.gitlab/media/preview.gif)
<br> <h4><a href="https://kelteseth.gitlab.io/ScreenPlayDocs/wallpaper/wallpaper/">Wallpaper </a> and <a href="https://kelteseth.gitlab.io/ScreenPlayDocs/widgets/widgets/"> Widgets </a>Guide</h4>
</a>
<p>Click gif to see the Steam Early Access Trailer (YouTube)</p>
</div>
# Contributing for none programmer
# Contributing
Everyone can contribute with code, design, documentation or translation. Visit our [contributing guide](https://kelteseth.gitlab.io/ScreenPlayDocs/contribute/contribute) for more informations. Also check our [Collaboration Guidelines](Docs/CodeOfConduct.md).
* If you want to help [translate](https://kelteseth.gitlab.io/ScreenPlayDocs/contribute/translations/)
* If you are a [designer](https://kelteseth.gitlab.io/ScreenPlayDocs/contribute/contribute/#design)
* Help create example app via [HTML/QML/Javascript](https://kelteseth.gitlab.io/ScreenPlayDocs/)
Here are some ways you can contribute:
* by using prerelease versions / master branch or the Steam nightly builds
* by [adding/fixing translation](https://kelteseth.gitlab.io/ScreenPlayDocs/contribute/translations/)
* by [designing UI/UX](https://kelteseth.gitlab.io/ScreenPlayDocs/contribute/contribute/#design)
* by [creating example HTML/QML/Javascript Wallpaper/Widgets](https://kelteseth.gitlab.io/ScreenPlayDocs/)
* by [reporting bugs](https://gitlab.com/kelteseth/ScreenPlay/-/issues)
* by [writing or editing user documentation](https://gitlab.com/kelteseth/ScreenPlayDocs)
* by [writing needed](https://gitlab.com/kelteseth/ScreenPlay/-/issues?label_name%5B%5D=Feature)
* by [refactoring code](https://gitlab.com/kelteseth/ScreenPlay/-/issues?label_name%5B%5D=Code+Quality)
* by [reviewing merge requests](https://gitlab.com/kelteseth/ScreenPlay/-/merge_requests)
* by [verifying issues](https://gitlab.com/kelteseth/ScreenPlay/-/issues?label_name%5B%5D=Unverified)
# Contributing for programmer
# Coding
* [**Developer setup guide on how to download and compile ScreenPlay yourself.**](Docs/DeveloperSetup.md)
* 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:
* [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/)
# Content Creation
* [Wallpaper Guide](https://kelteseth.gitlab.io/ScreenPlayDocs/wallpaper/wallpaper/)
* [Widgets Guide](https://kelteseth.gitlab.io/ScreenPlayDocs/widgets/widgets/)
# Platform support
* ❌ Not working/Not implemented
* ❓ Only partical implemented/Not tested
* ❓ Only partical implemented/Not tested, help needed
<div align="center">
@ -55,8 +70,8 @@ Everyone can contribute with code, design, documentation or translation. Visit o
|------------------------ |--------- |------- |------- |
| __ScreenPlay Main App__ | ✔ | ✔ | ✔ |
| __Steam Binaries__ | ✔ | ❌ | ❌ |
| __Wallpaper__ | ✔ | ❌ Help Needed for Gnome/KDE/etc! | ✔ |
| __Widgets__ | ✔ | ❓ | ✔ |
| __Wallpaper__ | ✔ | ❓ Help Needed for Gnome/KDE/etc! | ✔ |
| __Widgets__ | ✔ | ✔ | ✔ |
| __Multilanguage (EN,DE,RU,FR,ES,KO🆕,VI🆕)__ | ✔ | ✔ | ✔ |
</div>
@ -72,9 +87,9 @@ __If you want to help and add new desktop environments look at ScreenPlayWallpap
<div align="center">
| Plattform | Windows 7 | Windows 8/8.1 | Windows 10 | Gnome | KDE | XFCE | MacOS |
|------------------------ |--------- |------- |------- |--------- |------- |------- | ------- |
| __Wallpaper__ | ❓ Help Needed! | ❓ Help Needed! | ✔ | ❌ Help Needed! | ❌ Help Needed! |❌ Help Needed! | ❓ (Basic implementation) Help Needed! |
| Plattform | Windows 10 | Gnome | KDE | MacOS |
|------------------------ |------- |--------- |------- | ------- |
| __Wallpaper__ | ✔ |❌ Help Needed! | ❓ (Basic implementation) | ❓ (Basic implementation) |
</div>