From 61d6c1362485931566b893e0f44d4abb1efa1ac6 Mon Sep 17 00:00:00 2001
From: Janis Hutz <98422316+simplePCBuilding@users.noreply.github.com>
Date: Wed, 24 May 2023 12:16:07 +0000
Subject: [PATCH] Update README.md

Add contributing guidelines, supported OS, FAQ, other cleanup work
---
 README.md | 54 +++++++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 43 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 8ec7f3f..b85ec5c 100644
--- a/README.md
+++ b/README.md
@@ -13,14 +13,22 @@
     <img src="https://img.shields.io/github/directory-file-count/simplePCBuilding/FSRImageVideoUpscalerFrontend.svg">
     <img src="https://img.shields.io/github/package-json/v/simplePCBuilding/FSRImageVideoUpscalerFrontend.svg">
 </div>
-A PyQT5 frontend to upscale images / videos using AMD's FidelityFX Super Resolution. 
+An Electron App with Python CLI to upscale images and videos using multiple different upscaling engines.
 
 # Functionality
-This App is a PyQT5 frontend to AMD's FidelityFX Super Resolution codebase, which allows you to upscale basically anything that is some kind of an image. 
+This app allows you to fully automatically upscale a single file or a full on folder with one of many different engines.
 - Choose an input & output file from a GUI filemanager.
 - Choose from different quality presets or set your own multiplier
 - You may upscale Images (currently .png, .jpg and .jpeg) or Videos (currently .mp4 and .mkv)
-- Output file will be written to the specified.
+- Choose from one of many different upscaling algorithms.
+- Add plugins to add even more upscaling engines to it
+
+## Engines
+- AMD Fidelity FX Super Resolution
+- Cubic scaling
+- High Quality Cubic
+- Real-ESGRAN
+- more to come!
 
 This App also features a CLI interface.
 - Options:
@@ -32,13 +40,21 @@ This App also features a CLI interface.
 -N 				--noscaling						No upscaling, requires -S option (Sharpening option)
 ```
 
+# Supported OS
+- Windows 10, 11 (officially)
+- Windows XP, Vista, 7, 8 (unofficially through python directly, may cause problems)
+- Any modern Linux distro with wine installed
+
 # Contributing
 If you have any suggestions or features you'd like to have implemented, you may either implement the feature yourself and open a pull request, or open an issue on this GitHub page. Both things are appreciated!
 *I am looking for somebody willing to maintain the Windows version (including installer) as I am running Linux*
 
-Current Contributers
-- simplePCBuilding
-- ThatPlasma
+--> Follow the rules layed out in CONTRIBUTING.md
+--> We will add a linter that will then run on circleci to ensure code quality is high
+
+### Current Contributers
+- simplePCBuilding (Maintainer) [Core (CLI), Docs, Website, Frontend, Linux packages]
+- ThatPlasma (Testing, Packager) [Testing, Windows Package]
 
 
 # Roadmap
@@ -63,10 +79,26 @@ V1.2.0:
 - Show progress of scaling
 
 # Issues
-The app is technically functional, but there may still be some big bugs. If you run into any of them, please open an issue on this Github page under "issues". I will attempt to fix them as fast as possible, but a fully compiled version might still take a couple of days to arrive. 
+If you encounter any problems with this app, please don't hesitate to open an issue on GitHub.
 
-# Supported OS
-Supported technically is every OS that can run python, but tested so far only Linux is. I will create a Windows exe, a rpm and deb package and maybe a dmg.
+## Known issues
+- Electron App is not available yet
+- GTK version only runs on Linux
 
-# INFO
-I will not be pushing the code to the main branch until there is a somewhat stable version in the dev-V1 branch. If you want to see the code, check it out there!
+# FAQ
+Q: Can you add upscaling engine [upscaling engine here]?
+A: We can add it most likely, please open an issue that contains a link to the library and please try and upscale an image using it yourself and copy-paste the command into a comment.
+Just remember that it might take time to implement it and this is all developed in our free time and we have no obligation to implement it.
+
+Q: App no worky on OS XXXX
+A: Please check [Supported OS](#supported-os) that your OS is actually supported officially. If so, please open an issue and provide command used (if CLI) and error message that the app spat out when running.
+If the OS is not officially supported, we may not be able to help you, since we intentionally don't support it officially
+
+Q: Why no worky on MacOS? / Can you port to MacOS?
+A: MacOS cannot run some of the upscalers included by default so we cannot support it.
+
+Q: Upscaled XXX looks not as great as I want
+A: Try out different engines (that's why we support so many) and try to use sharpening to improve quality. If it doesn't help, you might want to suggest another engine.
+
+Q: How can I support you?
+A: You may contribute to this project by writing documentation, improving the website, adding plugins, fixing bugs, testing or by donating. 
\ No newline at end of file