aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorMichael C <[email protected]>2023-07-06 16:33:03 -0400
committerMichael C <[email protected]>2023-07-06 16:33:03 -0400
commitd25e8c7360b70cb08d0361051f026a70414d3f53 (patch)
tree36aec6498dbc477959cbe00362059f0c1a45553c
parent87bf472ee459d117c50e1447430ac7601eda2beb (diff)
downloadSponsorBlock-d25e8c7360b70cb08d0361051f026a70414d3f53.tar.gz
SponsorBlock-d25e8c7360b70cb08d0361051f026a70414d3f53.zip
update CONTRIBUTING for windows
-rw-r--r--CONTRIBUTING.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 60bd0953..8fd62361 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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 \ No newline at end of file