Skip to content

Commit 108faa7

Browse files
committed
docs: Flag that this branch is no longer being used
**This branch is now defunked**. Our Experience CS fork has been migrated over to a new mono-repo: https://github.com/RaspberryPiFoundation/scratch-editor
1 parent d9ffbd6 commit 108faa7

File tree

1 file changed

+32
-22
lines changed

1 file changed

+32
-22
lines changed

README.md

Lines changed: 32 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# scratch-gui
22

3+
## **⚠️ NOTICE: Repository Migration to Mono-Repo ⚠️**
4+
5+
**This branch is now defunked**.
6+
7+
Our Experience CS fork has been migrated over to a new mono-repo:
8+
9+
https://github.com/RaspberryPiFoundation/scratch-editor
10+
11+
## Overview
12+
313
Scratch GUI is a set of React components that comprise the interface for creating and running Scratch 3.0 projects
414

515
To open the current build in your browser on Github Pages:
@@ -102,7 +112,6 @@ Then go to [http://localhost:8601/](http://localhost:8601/) - the playground out
102112

103113
### Getting another repo to point to this code (using `npm link`)
104114

105-
106115
If you wish to develop `scratch-gui` alongside other scratch repositories that depend on it, you may wish
107116
to have the other repositories use your local `scratch-gui` build instead of fetching the current production
108117
version of the scratch-gui that is found by default using `npm install`.
@@ -112,6 +121,7 @@ Here's how to link your local `scratch-gui` code to another project's `node_modu
112121
#### Configuration
113122

114123
1. In your local `scratch-gui` repository's top level:
124+
115125
1. Make sure you have run `npm install`
116126
2. Build the `dist` directory by running `BUILD_MODE=dist npm run build`
117127
3. Establish a link to this repository by running `npm link`
@@ -131,13 +141,13 @@ unreliable; if you are having problems, try going back to `BUILD_MODE=dist npm r
131141

132142
If you can't get linking to work right, try:
133143

134-
* Follow the recipe above step by step and don't change the order. It is especially important to run `npm install`
135-
_before_ `npm link` as installing after the linking will reset the linking.
136-
* Make sure the repositories are siblings on your machine's file tree, like
137-
`.../.../MY_SCRATCH_DEV_DIRECTORY/scratch-gui/` and `.../.../MY_SCRATCH_DEV_DIRECTORY/scratch-www/`.
138-
* Consistent node.js version: If you have multiple Terminal tabs or windows open for the different Scratch
139-
repositories, make sure to use the same node version in all of them.
140-
* If nothing else works, unlink the repositories by running `npm unlink` in both, and start over.
144+
- Follow the recipe above step by step and don't change the order. It is especially important to run `npm install`
145+
_before_ `npm link` as installing after the linking will reset the linking.
146+
- Make sure the repositories are siblings on your machine's file tree, like
147+
`.../.../MY_SCRATCH_DEV_DIRECTORY/scratch-gui/` and `.../.../MY_SCRATCH_DEV_DIRECTORY/scratch-www/`.
148+
- Consistent node.js version: If you have multiple Terminal tabs or windows open for the different Scratch
149+
repositories, make sure to use the same node version in all of them.
150+
- If nothing else works, unlink the repositories by running `npm unlink` in both, and start over.
141151

142152
##### Getting another repo to point to this code (using `npm pack`)
143153

@@ -175,7 +185,7 @@ See [jest cli docs](https://facebook.github.io/jest/docs/en/cli.html#content) fo
175185

176186
### Running tests
177187

178-
*NOTE: If you're a Windows user, please run these scripts in Windows `cmd.exe` instead of Git Bash/MINGW64.*
188+
_NOTE: If you're a Windows user, please run these scripts in Windows `cmd.exe` instead of Git Bash/MINGW64._
179189

180190
Before running any tests, make sure you have run `npm install` from this (scratch-gui) repository's top level.
181191

@@ -324,24 +334,24 @@ used, which relate to each other:
324334

325335
These include state constant strings like:
326336

327-
* `NOT_LOADED` (the default state),
328-
* `ERROR`,
329-
* `FETCHING_WITH_ID`,
330-
* `LOADING_VM_WITH_ID`,
331-
* `REMIXING`,
332-
* `SHOWING_WITH_ID`,
333-
* `SHOWING_WITHOUT_ID`,
334-
* etc.
337+
- `NOT_LOADED` (the default state),
338+
- `ERROR`,
339+
- `FETCHING_WITH_ID`,
340+
- `LOADING_VM_WITH_ID`,
341+
- `REMIXING`,
342+
- `SHOWING_WITH_ID`,
343+
- `SHOWING_WITHOUT_ID`,
344+
- etc.
335345

336346
### Transitions
337347

338348
These are names for the action which causes a state change. Some examples are:
339349

340-
* `START_FETCHING_NEW`,
341-
* `DONE_FETCHING_WITH_ID`,
342-
* `DONE_LOADING_VM_WITH_ID`,
343-
* `SET_PROJECT_ID`,
344-
* `START_AUTO_UPDATING`,
350+
- `START_FETCHING_NEW`,
351+
- `DONE_FETCHING_WITH_ID`,
352+
- `DONE_LOADING_VM_WITH_ID`,
353+
- `SET_PROJECT_ID`,
354+
- `START_AUTO_UPDATING`,
345355

346356
### How transitions relate to loading states
347357

0 commit comments

Comments
 (0)