Update documentation

This commit is contained in:
Iwan Timmer
2014-08-16 15:44:56 +02:00
parent 43ed1d727d
commit 0e763f425e
2 changed files with 45 additions and 15 deletions

View File

@@ -25,7 +25,7 @@ implementation.
* Download [GeForce Experience](http://www.geforce.com/geforce-experience) and install on your Windows PC
* Install oracle-java8-jdk (Raspbian) or download and install [Oracle Java SE (ARM v6 Hard Float)](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-arm-downloads-2187472.html)
* Download the appropriate jar from the [GitHub releases page](https://github.com/irtimmer/limelight-pi/releases)
* Download the compiled jar from the [GitHub releases page](https://github.com/irtimmer/limelight-pi/releases)
* Install libopus0 (Debian/Raspbian) or opus (ArchLinux/Fedora/Pidora)
* [Configure sound](http://elinux.org/R-Pi_Troubleshooting#Sound)
@@ -33,16 +33,46 @@ implementation.
* [GFE compatible](http://shield.nvidia.com/play-pc-games/) computer with GTX 600/700 series GPU (for the PC you're streaming from)
* High-end wireless router (802.11n dual-band recommended) or Wired network
* Geforce Experience 2.1.1 or higher
##Usage
##Quick Start
* Ensure your machine and Raspberry Pi are on the same network
* Turn on Shield Streaming in the GFE settings
* Start Limelight Pi with -pair option
* Start Limelight Pi with pair
* Accept the pairing confirmation on your PC
* Start Limelight Pi normally
* Start Limelight Pi with stream
* Play games!
##Usage
Usage: java -jar limelight-pi.jar [options] host
Actions:
pair Pair device with computer
stream Stream computer to device
discover List available computers
list List available games and applications
help Show this help
Streaming options:
-720 Use 1280x720 resolution (default)
-1080 Use 1920x1080 resolution
-width <width> Horizontal resolution (default 1280)
-height <height>Vertical resolution (default 720)
-30fps Use 30fps
-60fps Use 60fps (default)
-bitrate <bitrate>Specify the bitrate in Kbps
-app <app> Name of app to stream
-nosops Don't allow GFE to modify game settings
-input <device> Use <device> as input. Can be used multiple times
(default uses all devices in /dev/input)
-mapping <file> Use <file> as gamepad mapping configuration file
-audio <device> Use <device> as ALSA audio output device (default sysdefault)
Use ctrl-c to exit application
##Compile
* Install ant (Debian/Raspbian/Fedora/Pidora) or apache-ant (Archlinux)

View File

@@ -318,24 +318,24 @@ public class Limelight implements NvConnectionListener {
System.out.println("\tpair\t\t\tPair device with computer");
System.out.println("\tstream\t\t\tStream computer to device");
System.out.println("\tdiscover\t\tList available computers");
System.out.println("\tlist\t\tList available games and applications");
System.out.println("\tlist\t\t\tList available games and applications");
System.out.println("\thelp\t\t\tShow this help");
System.out.println();
System.out.println(" Streaming options:");
System.out.println();
System.out.println("\t-720\t\tUse 1280x720 resolution [default]");
System.out.println("\t-1080\t\tUse 1920x1080 resolution");
System.out.println("\t-width <width>\tHorizontal resolution (default 1280)");
System.out.println("\t-720\t\t\tUse 1280x720 resolution [default]");
System.out.println("\t-1080\t\t\tUse 1920x1080 resolution");
System.out.println("\t-width <width>\t\tHorizontal resolution (default 1280)");
System.out.println("\t-height <height>\tVertical resolution (default 720)");
System.out.println("\t-30fps\t\tUse 30fps");
System.out.println("\t-60fps\t\tUse 60fps [default]");
System.out.println("\t-bitrate <bitrate>\t\tSpecify the bitrate in Kbps");
System.out.println("\t-30fps\t\t\tUse 30fps");
System.out.println("\t-60fps\t\t\tUse 60fps [default]");
System.out.println("\t-bitrate <bitrate>\tSpecify the bitrate in Kbps");
System.out.println("\t-app <app>\t\tName of app to stream");
System.out.println("\t-nosops\t\t\tDon't allow GFE to modify game settings");
System.out.println("\t-input <device>\tUse <device> as input. Can be used multiple times");
System.out.println("\t\t\t[default uses all devices in /dev/input]");
System.out.println("\t-mapping <file>\tUse <file> as gamepad mapping configuration file");
System.out.println("\t-audio <device>\tUse <device> as ALSA audio output device (default hw:0)");
System.out.println("\t-input <device>\t\tUse <device> as input. Can be used multiple times");
System.out.println("\t\t\t\t[default uses all devices in /dev/input]");
System.out.println("\t-mapping <file>\t\tUse <file> as gamepad mapping configuration file");
System.out.println("\t-audio <device>\t\tUse <device> as ALSA audio output device (default sysdefault)");
System.out.println();
System.out.println("Use ctrl-c to exit application");
System.exit(5);