GHI Electronics Brain Pad target for MakeCode

Local Dev setup

These instructions assume familiarity with dev tools and languages.

• install Node.js 6+
• (optional) install Visual Studio Code

In a common folder,

• clone https://github.com/Microsoft/pxt to pxt folder
• clone https://github.com/Microsoft/pxt-common-packages to pxt-common-packages folder
• clone https://github.com/Microsoft/pxt-brainpad to pxt-brainpad folder
• go to pxt and run

npm install
jake

• go to pxt-common-packages and run

npm install
npm link ../pxt

• go to pxt-brainpad and run

npm install
npm link ../pxt
npm link ../pxt-common-packages

to run the local server

From root github folder,

cd pxt-brainpad
pxt serve --cloud

If you are editing C++, install [docker.com] and make sure your drive is shared.

pxt serve

to build and deploy a single package via command line

cd libs/core
pxt deploy

Updating CODAL dependency

• Update the tag number in pxtarget.json at https://github.com/Microsoft/pxt-brainpad/blob/master/pxtarget.json#L203
• clean the build

pxt clean

• build again

pxt buildtarget

Releasing the editor

The version served under / is controlled by /docs/index-ref.json. Change the version in that file and push to immediately update the version.

Each time you bump (using pxt bump) and the build passes, the /beta will point to that release. /beta can be used to test new features before pushing down the release to all users. The update is handled automatically by MakeCode afterwards.

Be careful when updating the version number of the editor, as MakeCode follows semver. In particular, do not change the major version unless you are releasing a completely new and incompatible editor.

• run pxt udpdate to pick any updates to the PXT engine
• run pxt bump to create a new release (say vX.Y.Z)
• wait for build to finish, typically 10 minutes
• test new build in /beta. You can check the version number in the bottom of the home screen is vX.Y.Z. Remember that it will update the background and load after a dozen of seconds or so.
• when ready and tested, run pxt tag index vX.Y.Z, and commit /docs/index-ref.json if successfull. This command does some routine checks to make sure everything is ok.

License

MIT

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.