scratchfoundation/scratch-desktop
1
0
Fork 0
mirror of https://github.com/scratchfoundation/scratch-desktop.git synced 2024-12-22 21:52:31 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

update README.md for scratch-gui build changes

Browse source
This commit is contained in:
Christopher Willis-Ford 2020-09-16 16:04:23 -07:00
parent cca18b6d67
commit ac6935660a
1 changed files with 8 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
README.md
View file

@ -4,45 +4,16 @@ Scratch 3.0 as a standalone desktop application
## Developer Instructions
### Prepare `scratch-gui`
### A note about `scratch-gui`
This step is temporary: eventually, the `scratch-desktop` branch of the Scratch GUI repository will be merged with
that repository's main development line. For now, though, the `scratch-desktop` branch holds a few changes that are
necessary for Scratch Desktop to function correctly but are not yet merged into the main development branch.
Eventually, the `scratch-desktop` branch of the Scratch GUI repository will be merged with that repository's main
development line. For now, though, the `scratch-desktop` branch holds a few changes that are necessary for Scratch
Desktop to function correctly but are not yet merged into the main development branch. If you only intend to build or
work on the `scratch-desktop` repository then you can ignore this, but if you intend to work on `scratch-gui` as well,
make sure you use the `scratch-desktop` branch there.
#### Prepare `scratch-gui`: Quick Start
1. Clone both `scratch-desktop` and `scratch-gui`
2. `cd scratch-gui`
1. `git checkout scratch-desktop`
2. `npm install`
3. `npm link`
4. `cd ..`
3. `cd scratch-desktop`
1. `npm install`
2. `npm link scratch-gui`
3. `npm run build-gui` or `npm run watch-gui`
Your copy of `scratch-gui` should now be ready for use with Scratch Desktop.
#### Prepare `scratch-gui`: Detailed Version
1. Clone the `scratch-gui` repository if you haven't already.
2. Switch to the `scratch-desktop` branch with `git checkout scratch-desktop`
3. Build with `BUILD_MODE=dist` and `STATIC_PATH=static`:
- macOS, WSL, or Cygwin: run `BUILD_MODE=dist STATIC_PATH=static npm run build` or
`BUILD_MODE=dist STATIC_PATH=static npm run watch`
- Running `npm run build-gui` in `scratch-desktop` is a shortcut for this when using `npm link`.
- CMD: run `set BUILD_MODE=dist` once and `set STATIC_PATH=static` once, then `npm run build` or `npm run watch`
any number of times in the same
window.
- PowerShell: run `$env:BUILD_MODE = "dist"` once and `$env:STATIC_PATH = "static"` once, then `npm run build` or
`npm run watch` any number of times in the same window.
If you have run `npm link scratch-gui` (or equivalent) in the `scratch-desktop` working directory, you may be able to
accomplish the above by running `npm run build-gui` in the `scratch-desktop` directory instead of using the manual
steps listed above. For active development iteration, try `npm run watch-gui` which will watch for changes and rebuild
`scratch-gui` incrementally when necessary.
Previously it was necessary to explicitly build `scratch-gui` before building `scratch-desktop`. This is no longer
necessary and the related build scripts, such as `build-gui`, have been removed.
### Prepare media library assets