Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update/Add README.md for Mac/Win build installer script #1355

Merged
merged 1 commit into from
Sep 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions scripts/mac_installer/README.md
Original file line number Diff line number Diff line change
@@ -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
24 changes: 24 additions & 0 deletions scripts/win_installer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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