From 4bfeccec7426149c4642c11fa34c373a294f9970 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Sat, 28 Jul 2018 03:45:45 -0700 Subject: [PATCH] Update README with more information --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e986e40..96a7b179 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,20 @@ # Moonlight PC -[Moonlight PC](http://moonlight-stream.com) is an open source implementation of NVIDIA's GameStream, as used by the NVIDIA Shield, but built to run on Windows, Mac, and Linux. +[Moonlight PC](http://moonlight-stream.com) is an open source implementation of NVIDIA's GameStream, as used by the NVIDIA Shield, but built to run on Windows, Mac, and Linux. This client is the successor to [Moonlight Chrome](https://github.com/moonlight-stream/moonlight-chrome) for streaming on PC. Moonlight also has mobile versions for [Android](https://github.com/moonlight-stream/moonlight-android) and [iOS](https://github.com/moonlight-stream/moonlight-ios). +This client is currently still in development (pre-alpha), but the streaming performance is already much better than the older Moonlight Chrome client on many machines. Test releases may be available for your OS on the [Releases page](https://github.com/moonlight-stream/moonlight-qt/releases). + +## Features + - Hardware accelerated video decoding on Windows, Mac, and Linux + - Supports streaming at up to 90 FPS on high refresh rate monitors + - Supports streaming at 720p, 1080p, 1440p, or 4K + - 5.1 surround sound audio + - HEVC support for better image quality at reduced bandwidth + - Keyboard and mouse support + - Gamepad support with SDL gamepad mappings + ## Building 1. Install the latest Qt SDK (and optionally, the Qt Creator IDE) from https://www.qt.io/download (select MSVC toolchain on Windows) 2. Run `git submodule update --init --recursive` from within `moonlight-qt/`