Skip to content

Commit ca16611

Browse files
committed
Add development instructions to readme.
1 parent b48bd4f commit ca16611

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,37 @@ I made this app because I would often not notice my chat messages on my other mo
1010

1111
Head over to the [releases page](https://github.com/hperrin/stream-overlay/releases) to download the latest version.
1212

13+
## Development
14+
15+
After checking out the repo, run the following in the repo's folder.
16+
17+
```sh
18+
npm install
19+
cd app/app
20+
npm install
21+
cd ../..
22+
npm start
23+
```
24+
25+
Under most circumstances, it's easiest to just Ctrl+C that instance and run `npm start` again, instead of running watchers.
26+
27+
When you've completed your changes and are ready to package it up, run the following.
28+
29+
```sh
30+
npm run clean
31+
npm run build
32+
npm run package:windows # or package:linux
33+
```
34+
35+
And if you want to build the flatpak and install it locally (on Linux), run the following after the above commands.
36+
37+
```sh
38+
git submodule init
39+
git submodule update
40+
npm run flatpak:generate-manifest
41+
npm run package:flatpak
42+
```
43+
1344
## Support Me
1445

1546
You can support me directly by supporting my software company, SciActive, on Patreon:

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"format": "prettier --write --plugin-search-dir=. .",
1515
"package:linux": "electron-builder build --x64 --linux",
1616
"package:windows": "electron-builder build --x64 --win",
17-
"package:flatpak": "npm run flatpak:generate-manifest && flatpak-builder build flatpak/com.hperrin.StreamOverlay.yml --install --force-clean --user",
17+
"package:flatpak": "flatpak-builder build flatpak/com.hperrin.StreamOverlay.yml --install --force-clean --user",
1818
"flatpak:generate-manifest": "python3 flatpak-builder-tools/node/flatpak-node-generator.py npm -r -o flatpak/generated-sources.json --xdg-layout app/package-lock.json",
1919
"test": "echo \"Error: no test specified\" && exit 1",
2020
"postinstall": "electron-builder install-app-deps"

0 commit comments

Comments
 (0)