add "quick start" instructions for scratch-gui

This commit is contained in:
Christopher Willis-Ford 2019-07-29 15:22:49 -07:00
parent 1b8d9796c9
commit 53f20c3d61

View file

@ -7,7 +7,25 @@ Scratch 3.0 as a standalone desktop application
### Prepare `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, there's a separate branch:
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.
#### 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`