diff --git a/README.md b/README.md index 4b5b91ea8c4d429d11f1e87b0f49af2d88ccf874..1644c0f497f5f6448b9716b9b235da28ab570f69 100644 --- a/README.md +++ b/README.md @@ -35,14 +35,21 @@ to have the other repositories use your local scratch-gui build instead of fetch version of the scratch-gui that is found by default using `npm install`. To do this: - -1. Make sure you have run `npm install` from this repository's top level +1. Make sure you have run `npm install` from this (scratch-gui) repository's top level 2. Make sure you have run `npm install` from the top level of each repository (such as scratch-www) that depends on scratch-gui -3. From this repository's top level, build the `dist` directory by running `BUILD_MODE=dist npm run build` -4. From this repository's top level, establish a link to this repository by running `npm link` +3. From this (scratch-gui) repository's top level, build the `dist` directory by running `BUILD_MODE=dist npm run build` +4. From this (scratch-gui) repository's top level, establish a link to this repository by running `npm link` 5. From the top level of each repository that depends on scratch-gui, run `npm link scratch-gui` 6. Build or run the repositories that depend on scratch-gui +Instead of `BUILD_MODE=dist npm run build` you can also use `BUILD_MODE=dist npm run watch`, however this may be unreliable. + +### Oh no! It didn't work! +* Follow the recipe above step by step and don't change the order. It is especially important to run npm first because installing after the linking will reset the linking. +* Make sure the repositories are siblings on your machine's file tree. +* If you have multiple Terminal tabs or windows open for the different Scratch repositories, make sure to use the same node version in all of them. +* In the worst case unlink the repositories with `npm unlink` and start over. + ## Testing NOTE: If you're a windows user, please run these scripts in Windows `cmd.exe` instead of Git Bash/MINGW64.