From 19b94b1984d7ec65b67c1d2695361027a37d6319 Mon Sep 17 00:00:00 2001 From: Elias Steurer Date: Tue, 22 Dec 2020 15:24:36 +0000 Subject: [PATCH] Update README.md --- README.md | 43 +++++++++++++++++++++++++++++-------------- 1 file changed, 29 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 109d9085..c578c3dd 100644 --- a/README.md +++ b/README.md @@ -20,34 +20,49 @@ ScreenPlay is an open source cross platform app for displaying Video Wallpaper,

Homepage - Forum - 🎉 Discord (Free Steam Key Here!) - Reddit - Steam


+ + ![Preview](.gitlab/media/preview.gif) -

Wallpaper and Widgets Guide

+ +

Click gif to see the Steam Early Access Trailer (YouTube)

-# 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
@@ -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🆕)__ | ✔ | ✔ | ✔ |
@@ -72,9 +87,9 @@ __If you want to help and add new desktop environments look at ScreenPlayWallpap
-| 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) |