-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: drop sphinx and use doxygen exclusively (#2932)
- Loading branch information
1 parent
adf068e
commit 4bd521b
Showing
67 changed files
with
4,791 additions
and
5,307 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -40,6 +40,7 @@ | |
| # build directories | ||
| build/ | ||
| cmake-*/ | ||
| docs/*-doxyconfig* | ||
|
|
||
| # npm | ||
| node_modules/ | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| # Overview | ||
|
|
||
| [](https://github.com/LizardByte/Sunshine) | ||
| [](https://github.com/LizardByte/Sunshine/releases/latest) | ||
| [](https://hub.docker.com/r/lizardbyte/sunshine) | ||
| [](https://github.com/LizardByte/Sunshine/pkgs/container/sunshine) | ||
| [](https://github.com/microsoft/winget-pkgs/tree/master/manifests/l/LizardByte/Sunshine) | ||
| [](https://github.com/LizardByte/Sunshine/actions/workflows/CI.yml?query=branch%3Amaster) | ||
| [](https://github.com/LizardByte/Sunshine/actions/workflows/localize.yml?query=branch%3Amaster) | ||
| [](http://sunshinestream.readthedocs.io) | ||
| [](https://codecov.io/gh/LizardByte/Sunshine) | ||
|
|
||
| LizardByte has the full documentation hosted on [Read the Docs](https://sunshinestream.readthedocs.io). | ||
|
|
||
| ## About | ||
|
|
||
| Sunshine is a self-hosted game stream host for Moonlight. | ||
| Offering low latency, cloud gaming server capabilities with support for AMD, Intel, and Nvidia GPUs for hardware | ||
| encoding. Software encoding is also available. You can connect to Sunshine from any Moonlight client on a variety of | ||
| devices. A web UI is provided to allow configuration, and client pairing, from your favorite web browser. Pair from | ||
| the local server or any mobile device. | ||
|
|
||
| ## System Requirements | ||
|
|
||
| @warning{These tables are a work in progress. Do not purchase hardware based on this information.} | ||
|
|
||
| <table> | ||
| <caption id="minimum_requirements">Minimum Requirements</caption> | ||
| <tr> | ||
| <th>Component</th> | ||
| <th>Requirement</th> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="3">GPU</td> | ||
| <td>AMD: VCE 1.0 or higher, see: <a href="https://github.com/obsproject/obs-amd-encoder/wiki/Hardware-Support">obs-amd hardware support</a></td> | ||
| </tr> | ||
| <tr> | ||
| <td>Intel: VAAPI-compatible, see: <a href="https://www.intel.com/content/www/us/en/developer/articles/technical/linuxmedia-vaapi.html">VAAPI hardware support</a></td> | ||
| </tr> | ||
| <tr> | ||
| <td>Nvidia: NVENC enabled cards, see: <a href="https://developer.nvidia.com/video-encode-and-decode-gpu-support-matrix-new">nvenc support matrix</a></td> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="2">CPU</td> | ||
| <td>AMD: Ryzen 3 or higher</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Intel: Core i3 or higher</td> | ||
| </tr> | ||
| <tr> | ||
| <td>RAM</td> | ||
| <td>4GB or more</td> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="5">OS</td> | ||
| <td>Windows: 10+ (Windows Server does not support virtual gamepads)</td> | ||
| </tr> | ||
| <tr> | ||
| <td>macOS: 12+</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Linux/Debian: 12+ (bookworm)</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Linux/Fedora: 39+</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Linux/Ubuntu: 22.04+ (jammy)</td> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="2">Network</td> | ||
| <td>Host: 5GHz, 802.11ac</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Client: 5GHz, 802.11ac</td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| <table> | ||
| <caption id="4k_suggestions">4k Suggestions</caption> | ||
| <tr> | ||
| <th>Component</th> | ||
| <th>Requirement</th> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="3">GPU</td> | ||
| <td>AMD: Video Coding Engine 3.1 or higher</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Intel: HD Graphics 510 or higher</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Nvidia: GeForce GTX 1080 or higher</td> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="2">CPU</td> | ||
| <td>AMD: Ryzen 5 or higher</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Intel: Core i5 or higher</td> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="2">Network</td> | ||
| <td>Host: CAT5e ethernet or better</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Client: CAT5e ethernet or better</td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| <table> | ||
| <caption id="hdr_suggestions">HDR Suggestions</caption> | ||
| <tr> | ||
| <th>Component</th> | ||
| <th>Requirement</th> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="3">GPU</td> | ||
| <td>AMD: Video Coding Engine 3.4 or higher</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Intel: HD Graphics 730 or higher</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Nvidia: Nvidia: Pascal-based GPU (GTX 10-series) or higher</td> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="2">CPU</td> | ||
| <td>AMD: Ryzen 5 or higher</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Intel: Core i5 or higher</td> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="2">Network</td> | ||
| <td>Host: CAT5e ethernet or better</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Client: CAT5e ethernet or better</td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| ## Support | ||
|
|
||
| Our support methods are listed in our [LizardByte Docs](https://lizardbyte.readthedocs.io/en/latest/about/support.html). | ||
|
|
||
| <div class="section_buttons"> | ||
|
|
||
| | Previous | Next | | ||
| |:---------|------------------------------------:| | ||
| | | [Overview](docs/getting_started.md) | | ||
|
|
||
| </div> |
Oops, something went wrong.