From cdcb2334c2a75685ca2eb786ac4331b44eada8b4 Mon Sep 17 00:00:00 2001 From: Mohammed <79150699+mrpalide@users.noreply.github.com> Date: Tue, 13 Sep 2022 22:21:31 +0430 Subject: [PATCH] add Sort of Questions section (#1355) --- scripts/mac_installer/README.md | 24 ++++++++++++++++++++++++ scripts/win_installer/README.md | 24 ++++++++++++++++++++++++ 2 files changed, 48 insertions(+) create mode 100644 scripts/mac_installer/README.md diff --git a/scripts/mac_installer/README.md b/scripts/mac_installer/README.md new file mode 100644 index 0000000000..35077cda03 --- /dev/null +++ b/scripts/mac_installer/README.md @@ -0,0 +1,24 @@ +## Mac Installer + +### Sort of Questions +- Q: *What is the equivalent of the systemd service used for controlling the running process?* + + A: No systemd service there. User just should run app from menu or desktop shortcut. +- Q: *How do you manually start and stop skywire via this framework?* + + A: Running by shortcut on desktop or menu. +- Q: *How do you enable or disable skywire starting at boot?* + + A: Not available by UI or other things. Should add it manually by user to startup items. +- Q: *What is the default config file path?* + + A: `/Users/{user}/Library/Application Support/Skywire/skywire-config.json` +- Q: *What is included in the packaging besides skywire? (i.e. scripts, services, batch files, etc.)* + + A: - a bash script called **Skywire** that include a command to run skywire-visor on config. (Line 82 of create_installer.sh) +- Q: *Where are the sources for the build of the installer or package?* + + A: `scripts\mac_installer` +- Q: *What are the dependencies required to build either of these? mac package* + + A: nothing diff --git a/scripts/win_installer/README.md b/scripts/win_installer/README.md index 48da637c88..756080486f 100644 --- a/scripts/win_installer/README.md +++ b/scripts/win_installer/README.md @@ -26,3 +26,27 @@ To run skywire open a terminal or cmd window and run skywire ``` or open `skywire` shortcut on start menu or desktop. + +### Sort of Questions +- Q: *What is the equivalent of the systemd service used for controlling the running process?* + + A: No systemd service there. User just should run app from menu or desktop shortcut. +- Q: *How do you manually start and stop skywire via this framework?* + + A: Running by shortcut on desktop or menu. +- Q: *How do you enable or disable skywire starting at boot?* + + A: Not available by UI or other things. Should add it manually by user to startup items. +- Q: *What is the default config file path?* + + A: `C:\Program Files\Skywire\skywire-config.json` +- Q: *What is included in the packaging besides skywire? (i.e. scripts, services, batch files, etc.)* + + A: - a `.bat` file that use for running skywire + - a `new.update` file for checking update then regenerate config file for update version and etc +- Q: *Where are the sources for the build of the installer or package?* + + A: `scripts\win_installer` +- Q: *What are the dependencies required to build either of these? .msi* + + A: `wix` and `wintun` , but both of them downloaded during building `.msi` installer