Skip to content

Commit 3aa33b8

Browse files
authored
Merge pull request #1 from smalruby/fix_readme
changed for Smalruby3.
2 parents 0bf03a2 + 866df3c commit 3aa33b8

File tree

1 file changed

+19
-35
lines changed

1 file changed

+19
-35
lines changed

README.md

Lines changed: 19 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,37 @@
1-
# scratch-desktop
1+
# smalruby3-desktop
22

3-
Scratch 3.0 as a standalone desktop application
3+
Smalruby3 as a standalone desktop application forked from [LLK/scratch-desktop](https://github.com/LLK/scratch-desktop).
44

55
## Developer Instructions
66

7-
### Prepare `scratch-gui`
7+
### Prepare `smalruby3-gui`
88

9-
This step is temporary: eventually, the `scratch-desktop` branch of the Scratch GUI repository will be merged with
10-
that repository's main development line. For now, though, the `scratch-desktop` branch holds a few changes that are
9+
This step is temporary: eventually, the `smalruby3-desktop` branch of the smalruby3-gui repository will be merged with
10+
that repository's main development line. For now, though, the `smalruby3-desktop` branch holds a few changes that are
1111
necessary for Scratch Desktop to function correctly but are not yet merged into the main development branch.
1212

13-
#### Prepare `scratch-gui`: Quick Start
13+
#### Prepare `smalruby3-gui`: Quick Start
1414

15-
1. Clone both `scratch-desktop` and `scratch-gui`
16-
2. `cd scratch-gui`
17-
1. `git checkout scratch-desktop`
15+
1. Clone both `smalruby3-desktop` and `smalruby3-gui`
16+
1. `mkdir smalruby3`
17+
2. `cd smalruby3`
18+
3. `git clone https://github.com/smalruby/smalruby3-desktop.git`
19+
3. `git clone https://github.com/smalruby/smalruby3-gui.git`
20+
2. `cd smalruby3-gui`
21+
1. `git checkout smalruby3-desktop`
1822
2. `npm install`
1923
3. `npm link`
2024
4. `cd ..`
21-
3. `cd scratch-desktop`
25+
3. `cd smalruby3-desktop`
2226
1. `npm install`
23-
2. `npm link scratch-gui`
27+
2. `npm link smalruby3-gui`
2428
3. `npm run build-gui` or `npm run watch-gui`
2529

26-
Your copy of `scratch-gui` should now be ready for use with Scratch Desktop.
27-
28-
#### Prepare `scratch-gui`: Detailed Version
29-
30-
1. Clone the `scratch-gui` repository if you haven't already.
31-
2. Switch to the `scratch-desktop` branch with `git checkout scratch-desktop`
32-
3. Build with `BUILD_MODE=dist` and `STATIC_PATH=static`:
33-
- macOS, WSL, or Cygwin: run `BUILD_MODE=dist STATIC_PATH=static npm run build` or
34-
`BUILD_MODE=dist STATIC_PATH=static npm run watch`
35-
- Running `npm run build-gui` in `scratch-desktop` is a shortcut for this when using `npm link`.
36-
- CMD: run `set BUILD_MODE=dist` once and `set STATIC_PATH=static` once, then `npm run build` or `npm run watch`
37-
any number of times in the same
38-
window.
39-
- PowerShell: run `$env:BUILD_MODE = "dist"` once and `$env:STATIC_PATH = "static"` once, then `npm run build` or
40-
`npm run watch` any number of times in the same window.
41-
42-
If you have run `npm link scratch-gui` (or equivalent) in the `scratch-desktop` working directory, you may be able to
43-
accomplish the above by running `npm run build-gui` in the `scratch-desktop` directory instead of using the manual
44-
steps listed above. For active development iteration, try `npm run watch-gui` which will watch for changes and rebuild
45-
`scratch-gui` incrementally when necessary.
30+
Your copy of `smalruby3-gui` should now be ready for use with Smalruby3 Desktop.
4631

4732
### Prepare media library assets
4833

49-
In the `scratch-desktop` directory, run `npm run fetch`. Re-run this any time you update `scratch-gui` or make any
34+
In the `smalruby3-desktop` directory, run `npm run fetch`. Re-run this any time you update `smalruby3-gui` or make any
5035
other changes which might affect the media libraries.
5136

5237
### Run in development mode
@@ -61,8 +46,6 @@ Node that on macOS this will require installing various certificates.
6146

6247
#### Signing the NSIS installer (Windows, non-store)
6348

64-
*This section is relevant only to members of the Scratch Team.*
65-
6649
By default all Windows installers are unsigned. An APPX package for the Microsoft Store shouldn't be signed: it will
6750
be signed automatically as part of the store submission process. On the other hand, the non-Store NSIS installer
6851
should be signed.
@@ -102,7 +85,7 @@ configuration like this:
10285
"name": "Desktop",
10386
"type": "node",
10487
"request": "launch",
105-
"cwd": "${workspaceFolder:scratch-desktop}",
88+
"cwd": "${workspaceFolder:smalruby3-desktop}",
10689
"runtimeExecutable": "npm",
10790
"autoAttachChildProcesses": true,
10891
"runtimeArgs": ["start", "--"],
@@ -119,3 +102,4 @@ configuration like this:
119102
]
120103
},
121104
```
105+

0 commit comments

Comments
 (0)