Skip to content

Commit ff77f18

Browse files
committed
Add README section re the RPF customisation in this repo
1 parent 94f268e commit ff77f18

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
# scratch-gui
22
#### Scratch GUI is a set of React components that comprise the interface for creating and running Scratch 3.0 projects
33

4+
## Raspberry Pi Foundation customisation
5+
6+
[![CircleCI status of RaspberryPiFoundation/scratch-gui](https://circleci.com/gh/RaspberryPiFoundation/scratch-gui.svg?style=shield&circle-token=d6d268de56c55a3e520e59195047105029345eaf)](https://app.circleci.com/pipelines/github/RaspberryPiFoundation/scratch-gui?branch=code-club-world)
7+
8+
* This is a fork of [the canonical repo](https://github.com/LLK/scratch-gui.git) to allow us to customise it for the [Code Club World app](https://github.com/RaspberryPiFoundation/codeclubworld).
9+
10+
* The default branch of the canonical repo is `develop`, but the default branch of this repo is `code-club-world`. This is to make it clear that the latter is where we should be making changes, to make it easier to bring in changes from the upstream repo, and so we can have our own CircleCI configuration to automatically build the app.
11+
12+
* Commits pushed to the forked repo on GitHub trigger [builds on CircleCI](https://app.circleci.com/pipelines/github/RaspberryPiFoundation/scratch-gui) and a successful build results in the build output being deployed to GitHub Pages for this repo. The deployment makes use of an SSH key with write access to this repo.
13+
14+
* The deployment adds the build output to the `gh-pages` branch in a sub-directory with the same name as the current branch. Thus the app is available at a URL including that sub-directory, e.g. https://raspberrypifoundation.github.io/scratch-gui/code-club-world/ for the default `code-club-world` branch.
15+
416
## Installation
517
This requires you to have Git and Node.js installed.
618

0 commit comments

Comments
 (0)