update CONTRIBUTING for windows

This commit is contained in:
Michael C 2023-07-06 16:33:03 -04:00
parent 87bf472ee4
commit d25e8c7360
No known key found for this signature in database
GPG key ID: FFB04FB3B878B7B4

View file

@ -1 +1,15 @@
If you make any contributions to SponsorBlock after this file was created, you are agreeing that any code you have contributed will be licensed under LGPL-3.0.
# All Platforms
Make sure to pull and update all submodules
`git submodule update --init --recursive`
"? property does not exist on type ConfigClass"
> Make sure to copy `config.json.example` to `config.json` and remove comments
# Windows
"Cannot find module "../maze-utils"
- Enable "Developer Mode" in windows for symlinks
- `src/maze-utils` will not appear properly and builds will fail since it is is only rendered as a file
- Enable symlink support in git `git config --global core.symlinks true`
- run `git checkout -- src/maze-utils` in order to create a symlink instead of a text file