Skip to content

Commit 3426214

Browse files
committed
improve README
1 parent 9efa31b commit 3426214

2 files changed

Lines changed: 28 additions & 1 deletion

File tree

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,33 @@
22

33
This repository contains a modified version of **TurboWarp** (itself a modified version of Scratch) adapted for the CodeTorch project.
44

5+
### Building
6+
```
7+
git clone https://github.com/CodeTorchNET/CodeTorch-Block-Compiler
8+
cd CodeTorch-Block-Compiler
9+
10+
npm ci
11+
12+
nano .env # modify/create .env files (read more below)
13+
14+
npm start # starts it at localhost:8601
15+
```
16+
17+
the .env accepts the following:
18+
```
19+
APP_NAME=CodeTorch
20+
FORCE_EMBED=false # you should probably leave this false
21+
COLLABORATION_DEV_MODE=false
22+
23+
APP_DOMAIN=USELESS_FOR_MOST_DEV_CASES
24+
API_HOST=USELESS_FOR_MOST_DEV_CASES
25+
ASSET_HOST=USELESS_FOR_MOST_DEV_CASES
26+
EXTENSION_HOST=USELESS_FOR_MOST_DEV_CASES
27+
DEFAULT_CLOUD_HOST=USELESS_FOR_MOST_DEV_CASES
28+
TRUSTED_IFRAME_HOST=USELESS_FOR_MOST_DEV_CASES
29+
COLLABORATION_HOST=USELESS_FOR_MOST_DEV_CASES
30+
```
31+
532
### Licensing
633

734
* **GPLv3 Code**

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@
9292
"redux": "3.7.2",
9393
"redux-throttle": "0.1.1",
9494
"scratch-audio": "github:CodeTorchNET/scratch-audio#develop",
95-
"scratch-blocks": "github:CodeTorchNET/scratch-blocks#develop",
95+
"scratch-blocks": "github:CodeTorchNET/scratch-blocks#develop-builds",
9696
"scratch-paint": "github:CodeTorchNET/scratch-paint#develop",
9797
"scratch-render": "github:CodeTorchNET/scratch-render#develop",
9898
"scratch-storage": "github:CodeTorchNET/scratch-storage#develop",

0 commit comments

Comments
 (0)