Add readme

This commit is contained in:
Aaron Neyer
2013-12-11 21:08:23 -05:00
parent 58117c17cd
commit 7cf2d1a946

65
README.md Normal file
View File

@@ -0,0 +1,65 @@
#Limelight
Limelight is an open source implementation of NVIDIA's GameStream, as used by the NVIDIA Shield,
but built for Linux/OSX/Windows.
Limelight-pc allows you to stream your full collection of Steam games from
your powerful Windows desktop to another PC running Linux/OSX/Windows.
[Limelight](https://github.com/limelight-stream/limelight) also has an Android
implementation.
##Features
* Streams Steam and all of your games from your PC to your Linux/OSX/Windows
machine.
* Keyboard and Mouse support
* Full gamepad support for XBOX 360
* Full OSX Support
* Partial Linux Support
##Features to come
* Better Linux mouse support
* Windows support
* PS3/PS4 support
* Use mDNS to scan for compatible GFE machines on the network
* Choose from the list of available games instead of just launching Steam
##Installation
* Bundled solutions are not yet available for Limelight-pc, but it can be run
by downloading the source and exporting a JAR.
* Download [GeForce Experience](http://www.geforce.com/geforce-experience) and install on your Windows PC
##Requirements
* [GFE compatible](http://shield.nvidia.com/play-pc-games/) computer with GTX 600/700 series GPU
* High-end wireless router (802.11n dual-band recommended) or Wired network
##Usage
* Ensure your machines are on the same network
* Turn on Shield Streaming in the GFE settings
* In Limelight, enter your PC's IP or Hostname and click "Pair".
* Accept the pairing confirmation on your PC
* In Limelight, click "Start Streaming"
* Play games!
##Contribute
This project is being actively developed at [XDA](http://forum.xda-developers.com/showthread.php?t=2505510)
1. Fork us
2. Write code
3. Send Pull Requests
##Authors
* [Cameron Gutman](https://github.com/cgutman)
* [Diego Waxemberg](https://github.com/dwaxemberg)
* [Aaron Neyer](https://github.com/Aaronneyer)
* [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).