This repository has been archived by the owner on Apr 2, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README.md to include setup, starting locally and building
- Loading branch information
vdbongard
committed
Mar 23, 2020
1 parent
2629231
commit e0adc94
Showing
1 changed file
with
31 additions
and
8 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,40 @@ | ||
### Flatpak | ||
## Setup | ||
|
||
`yarn install` | ||
|
||
## Start locally | ||
|
||
`yarn start` | ||
|
||
## Build | ||
|
||
1. Adjust the build script in `package.json` to only include the target platform(s), e.g.: `electron-builder --linux` | ||
2. `yarn build` | ||
|
||
Platforms available: | ||
- Linux:`--linux` | ||
- Windows: `--win` | ||
- Mac: `--mac` | ||
|
||
### Flatpak (Linux) | ||
|
||
#### Dependencies | ||
1. `flatpak install flathub org.electronjs.Electron2.BaseApp` | ||
2. `flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo` | ||
3. `flatpak install flathub org.freedesktop.Sdk//19.08` | ||
|
||
1. `flatpak install flathub org.electronjs.Electron2.BaseApp` | ||
2. `flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo` | ||
3. `flatpak install flathub org.freedesktop.Sdk//19.08` | ||
4. `flatpak install flathub org.freedesktop.Platform//19.08` | ||
5. `dist/siptop-x.x.x.tar.gz` via `yarn build` | ||
|
||
#### Build and install | ||
#### Build and install | ||
|
||
`flatpak-builder build flatpak/com.greyrook.siptop.json --install --user --force-clean` | ||
|
||
#### Run | ||
#### Run | ||
|
||
`flatpak run com.greyrook.siptop` | ||
or via os launcher | ||
|
||
#### Uninstall | ||
`flatpak uninstall com.greyrook.siptop` | ||
#### Uninstall | ||
|
||
`flatpak uninstall com.greyrook.siptop` |