Update README

This commit is contained in:
Iwan Timmer
2014-01-07 02:51:46 +01:00
parent 7b4e791681
commit 815e56d7d8
+10 -19
View File
@@ -1,4 +1,4 @@
#Limelight #Limelight-pi
Limelight is an open source implementation of NVIDIA's GameStream, as used by the NVIDIA Shield, Limelight is an open source implementation of NVIDIA's GameStream, as used by the NVIDIA Shield,
but built for Linux/OSX/Windows. but built for Linux/OSX/Windows.
@@ -6,26 +6,20 @@ but built for Linux/OSX/Windows.
Limelight-pc allows you to stream your full collection of Steam games from Limelight-pc allows you to stream your full collection of Steam games from
your powerful Windows desktop to another PC or laptop running Linux/OSX/Windows. your powerful Windows desktop to another PC or laptop running Linux/OSX/Windows.
[Limelight](https://github.com/limelight-stream/limelight) also has an Android [Limelight](https://github.com/cgutman/limelight) also has an Android
implementation.
[Limelight-pc](https://github.com/limelight-stream/limelight-pc) also has an Linux (X)/OSX/Windows
implementation. implementation.
##Features ##Features
* Streams Steam and all of your games from your PC to your Linux/OSX/Windows * Streams Steam and all of your games from your PC to your Raspberry PI.
machine.
* Keyboard and Mouse support
* Full support for XBOX 360 controllers, PS3 and PS4 controllers, and other HID gamepads
* Full Windows, OS X, and Linux Support
##Features to come
* Use mDNS to scan for compatible GFE machines on the network
* Choose from the list of available games instead of just launching Steam
##Installation ##Installation
* Download [GeForce Experience](http://www.geforce.com/geforce-experience) and install on your Windows PC * Download [GeForce Experience](http://www.geforce.com/geforce-experience) and install on your Windows PC
* Download the appropriate jar from the [GitHub releases page](https://github.com/limelight-stream/limelight-pc/releases) * Download the appropriate jar from the [GitHub releases page](https://github.com/irtimmer/limelight-pi/releases) (currently unavailable)
##Requirements ##Requirements
@@ -36,10 +30,9 @@ implementation.
* Ensure your machines are on the same network * Ensure your machines are on the same network
* Turn on Shield Streaming in the GFE settings * Turn on Shield Streaming in the GFE settings
* In Limelight, enter your PC's IP or Hostname and click "Pair". * Start Limelight with --pair option
* Accept the pairing confirmation on your PC * Accept the pairing confirmation on your PC
* For gamepad support, make sure you've mapped your controller in the Options -> Gamepad Settings menu. * Start Limelight normally
* In Limelight, click "Start Streaming"
* Play games! * Play games!
##Contribute ##Contribute
@@ -52,10 +45,8 @@ This project is being actively developed at [XDA](http://forum.xda-developers.co
##Authors ##Authors
* [Iwan Timmer](https://github.com/irtimmer)
* [Cameron Gutman](https://github.com/cgutman) * [Cameron Gutman](https://github.com/cgutman)
* [Diego Waxemberg](https://github.com/dwaxemberg) * [Diego Waxemberg](https://github.com/dwaxemberg)
* [Aaron Neyer](https://github.com/Aaronneyer) * [Aaron Neyer](https://github.com/Aaronneyer)
* [Andrew Hennessy](https://github.com/yetanothername) * [Andrew Hennessy](https://github.com/yetanothername)
Limelight is the work of students at [Case Western](http://case.edu) and was
started as a project at [MHacks](http://mhacks.org).