Improve clearity instructions

This commit is contained in:
loki
2020-03-21 17:09:33 +01:00
parent 34b1ef8779
commit a9423574fe
4 changed files with 21 additions and 10 deletions
+14 -4
View File
@@ -4,8 +4,8 @@ Requirements:
Ubuntu 19.10: cmake libssl-dev libavdevice-dev libboost-thread-dev libboost-filesystem-dev libboost-log-dev libpulse-dev libopus-dev libxtst-dev libx11-dev libxfixes-dev libevdev-dev libxcb1-dev libxcb-shm0-dev libxcb-xfixes0-dev Ubuntu 19.10: cmake libssl-dev libavdevice-dev libboost-thread-dev libboost-filesystem-dev libboost-log-dev libpulse-dev libopus-dev libxtst-dev libx11-dev libxfixes-dev libevdev-dev libxcb1-dev libxcb-shm0-dev libxcb-xfixes0-dev
Compilation: Compilation:
* git clone <repository> --recurse-submodules * git clone https://github.com/loki-47-6F-64/sunshine.git --recurse-submodules
* mkdir build && cd build * cd sunshine && mkdir build && cd build
* cmake .. * cmake ..
* make * make
@@ -41,14 +41,24 @@ Requirements:
MSYS2 : mingw-w64-x86_64-openssl mingw-w64-x86_64-cmake mingw-w64-x86_64-toolchain mingw-w64-x86_64-ffmpeg mingw-w64-x86_64-boost MSYS2 : mingw-w64-x86_64-openssl mingw-w64-x86_64-cmake mingw-w64-x86_64-toolchain mingw-w64-x86_64-ffmpeg mingw-w64-x86_64-boost
Compilation: Compilation:
* git clone <repository> --recurse-submodules * git clone https://github.com/loki-47-6F-64/sunshine.git --recurse-submodules
* mkdir build && cd build * cd sunshine && mkdir build && cd build
* cmake -G"Unix Makefiles" .. * cmake -G"Unix Makefiles" ..
* make * make
Setup: Setup:
* <optional> Gamepad support: Download and run 'ViGEmBus_Setup_1.16.116.exe' from [https://github.com/ViGEm/ViGEmBus/releases] * <optional> Gamepad support: Download and run 'ViGEmBus_Setup_1.16.116.exe' from [https://github.com/ViGEm/ViGEmBus/releases]
== Static build ==
Requirements:
MSYS2 : mingw-w64-x86_64-openssl mingw-w64-x86_64-cmake mingw-w64-x86_64-toolchain mingw-w64-x86_64-ffmpeg mingw-w64-x86_64-boost git-lfs
Compilation:
* git lfs install
* git clone https://github.com/loki-47-6F-64/sunshine.git --recurse-submodules
* cd sunshine && mkdir build && cd build
* cmake -DSUNSHINE_STANDALONE=ON -DSUNSHINE_ASSETS_DIR=assets -G"Unix Makefiles" ..
* make
+4 -3
View File
@@ -152,11 +152,12 @@ void int_between_f(std::unordered_map<std::string, std::string> &vars, const std
void print_help(const char *name) { void print_help(const char *name) {
std::cout << std::cout <<
"Usage: "sv << name << " [options] [/path/to/configuration_file]"sv << std::endl << "Usage: "sv << name << " [options] [/path/to/configuration_file]"sv << std::endl <<
" Any configurable option can be overwritten with: <name>=<value>"sv << std::endl << std::endl << " Any configurable option can be overwritten with: \"name=value\""sv << std::endl << std::endl <<
" --help | print help"sv << std::endl << std::endl << " --help | print help"sv << std::endl << std::endl <<
" flags"sv << std::endl << " flags"sv << std::endl <<
" -0 | Read PIN from stdin"sv << std::endl << " -0 | Read PIN from stdin"sv << std::endl <<
" -1 | Do not read/write state to/from disk" << std::endl; " -1 | Do not load previously saved state and do retain any state after shutdown"sv << std::endl <<
" | Effectively starting as if for the first time without overwriting any pairings with your devices"sv;
} }
int apply_flags(const char *line) { int apply_flags(const char *line) {
@@ -167,7 +168,7 @@ int apply_flags(const char *line) {
config::sunshine.flags[config::flag::PIN_STDIN].flip(); config::sunshine.flags[config::flag::PIN_STDIN].flip();
break; break;
case '1': case '1':
config::sunshine.flags[config::flag::CLEAN_SLATE].flip(); config::sunshine.flags[config::flag::FRESH_STATE].flip();
break; break;
default: default:
std::cout << "Warning: Unrecognized flag: ["sv << *line << ']' << std::endl; std::cout << "Warning: Unrecognized flag: ["sv << *line << ']' << std::endl;
+1 -1
View File
@@ -58,7 +58,7 @@ struct input_t {
namespace flag { namespace flag {
enum flag_e : std::size_t { enum flag_e : std::size_t {
PIN_STDIN = 0, // Read PIN from stdin instead of http PIN_STDIN = 0, // Read PIN from stdin instead of http
CLEAN_SLATE, // Do not load or save state FRESH_STATE, // Do not load or save state
FLAG_SIZE FLAG_SIZE
}; };
} }
+2 -2
View File
@@ -162,7 +162,7 @@ void update_id_client(const std::string &uniqueID, std::string &&cert, op_e op)
break; break;
} }
if(!config::sunshine.flags[config::flag::CLEAN_SLATE]) { if(!config::sunshine.flags[config::flag::FRESH_STATE]) {
save_state(); save_state();
} }
} }
@@ -724,7 +724,7 @@ int create_creds(const std::string &pkey, const std::string &cert) {
} }
void start(std::shared_ptr<safe::signal_t> shutdown_event) { void start(std::shared_ptr<safe::signal_t> shutdown_event) {
bool clean_slate = config::sunshine.flags[config::flag::CLEAN_SLATE]; bool clean_slate = config::sunshine.flags[config::flag::FRESH_STATE];
if(clean_slate) { if(clean_slate) {
unique_id = util::uuid_t::generate().string(); unique_id = util::uuid_t::generate().string();