MattTheTekie/meta-grabber
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Move dev instructions to contributing file

Browse source
This commit is contained in:
Andreas Willi 2022-01-25 20:47:33 +01:00
commit 1cceb60f80
No known key found for this signature in database
GPG key ID: 3A54A036E8C99FBF
2 changed files with 10 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

10
CONTRIBUTING.md
View file

@ -7,3 +7,13 @@
1. Download the executables and make sure they work as expected.
1. Once the new executables are ready to be released, update the description of the draft if necessary and release it. The current commit will be tagged automatically.
1. Another GitHub Action which merges the new commits from `develop` into `master` will be triggered.
## Local development
Run it locally by following these steps:
1. Install dependencies: `npm i`
1. Start build: `npm run serve`
1. Start the electron app in a **new** terminal window: `npm run start`
Now you can make changes, save the modified files, then return to the app and reload (`ctrl+r` on Windows/Linux, `cmd+r` on macOS). Your changes should now appear in the app.

12
README.md
View file

@ -79,15 +79,3 @@ You can open a whole directory or even multiple at once. This option specifies w
##### ▶︎ Excluded terms
Files that contain one of the terms set here will not get included. This applies to the complete file name (including directory name). This option is mainly existing to not open sample files when importing whole directories. Defaults to `sample`.
## Local development
Run it locally by following these steps:
1. Install dependencies: `npm i`
1. Start build: `npm run serve`
1. Start the electron app in a **new** terminal window: `npm run start`
Now you can make changes, save the modified files, then return to the app and reload (`ctrl+r` on Windows/Linux, `cmd+r` on macOS). Your changes should now appear in the app.