README.md
1# Moonlight Embedded
2
3Moonlight Embedded is an open source implementation of NVIDIA's GameStream, as used by the NVIDIA Shield, but built for Linux.
4
5Moonlight Embedded allows you to stream your full collection of games from
6your powerful Windows desktop to your (embedded) Linux system, like Raspberry Pi, CuBox-i and ODROID.
7
8## Documentation
9
10More information about installing and runnning Moonlight Embedded is available on the [wiki](https://github.com/irtimmer/moonlight-embedded/wiki).
11
12## Requirements
13
14* [GFE compatible](http://shield.nvidia.com/play-pc-games/) computer with GTX 600/700/900/1000 series GPU (for the PC you're streaming from)
15* High-end wireless router (802.11n dual-band recommended) or wired network
16* Geforce Experience 2.1.1 or higher
17
18## Quick Start
19
20* Ensure your GFE server and client are on the same network
21* Turn on Shield Streaming in the GFE settings
22* Pair Moonlight Embedded with the GFE server
23* Accept the pairing confirmation on your PC
24* Connect to the GFE Server with Moonlight Embedded
25* Play games!
26
27## Bugs
28
29Please check the wiki and old bug reports before submitting a new bug report.
30
31Bugs can be reported to the [issue tracker](https://github.com/irtimmer/moonlight-embedded/issues).
32
33## See also
34
35[Moonlight-common-c](https://github.com/irtimmer/moonlight-common-c) is a fork of moonlight-common-c used by Moonlight Embedded
36
37## Contribute
38
391. Fork us
402. Write code
413. Send Pull Requests
42