Skip to content

Commit 3066d9b

Browse files
Update README.md
1 parent 0926a25 commit 3066d9b

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,33 @@
11
# scratch-player
2-
NPM Library to run Scratch in JS
2+
3+
**Best with *VSCode* as it knows *JSDoc* comments.**
4+
5+
Allows scripting with JavaScript with Scratch 3.0.
6+
7+
**NOTE: To Host() the renderer, you need the source from [this GitHub repository](https://github.com/JSInventions/scratch-player/), and no, you cannot build your own unless the ```gui``` folder with ```index.html``` and ```index.js``` exists.**
8+
9+
Tutorials on using scratch-player is by
10+
# OK! How do i Host() it then?
11+
Get those installed:
12+
* Node.js
13+
* Git
14+
And we go!
15+
16+
Open your terminal, then type:
17+
18+
```terminal
19+
git clone https://github.com/JSInventions/scratch-player.git
20+
```
21+
22+
And go to the source,
23+
24+
(It's your user folder by default on the Windows terminal),
25+
26+
them go to the ```examples``` folder and use the ```exam1.js``` in your terminal, in other words:
27+
28+
```terminal
29+
cd scratch-player
30+
cd examples
31+
node exam1.js
32+
```
33+
**notice: (you can also use nodemon if you want)**

0 commit comments

Comments
 (0)