Merge branch 'main' of https://github.com/microbit-apps/microcode-v2 into newDocs

Author: thomasjball

.github/workflows/codeql.yml

@@ -0,0 +1,51 @@
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll with GitHub Pages dependencies preinstalled
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/jekyll-gh-pages.yml

@@ -11,7 +11,7 @@ jobs:
             contents: write
         strategy:
             matrix:
-                node-version: [16.x]
+                node-version: [18.x]
         steps:
             - uses: actions/checkout@v4
               with:
@@ -21,33 +21,25 @@ jobs:
               with:
                   node-version: ${{ matrix.node-version }}
             - name: Cache npm and makecode
-              uses: actions/cache@v2
+              uses: actions/cache@v3
               with:
                   path: |
                       ~/.npm
                       ~/.pxt/mkc-cache
                   key: ${{ runner.os }}-${{ hashFiles('pxt.json') }}-${{ hashFiles('mkc*json') }}
                   restore-keys: |
                       ${{ runner.os }}-
-            - name: npm install makecode@0.34.5
+            - name: npm install makecode@1.3.4
               run: |
-                  npm install -g makecode@0.34.5
-            - name: build js
+                  npm install -g makecode@1.3.4
+            - name: build hex file
               run: |
-                  makecode --java-script -u
-            - name: build hardware N3
-              run: |
-                  makecode --hw N3
+                  makecode
             - name: copy files
               run: |
-                  cp ./built/binary.js ./assets/js/binary.js
-                  cp ./built/n3/binary.hex ./assets/firmware.hex
-            - name: build localized hex files
-              run: |
-                  yarn install --frozen-lockfile
-                  node ./scripts/lochex.mjs
+                  cp ./built/binary.hex ./assets/microcode.hex
             - name: upload modified assets
               uses: stefanzweifel/git-auto-commit-action@v4
               with:
-                  file_pattern: "assets/* _includes/*"
+                  file_pattern: "assets/*"
                   branch: main

.github/workflows/makecode-release.yml

@@ -12,7 +12,7 @@ jobs:
 
         strategy:
             matrix:
-                node-version: [16.x]
+                node-version: [18.x]
 
         steps:
             - uses: actions/checkout@v4
@@ -23,20 +23,17 @@ jobs:
               with:
                   node-version: ${{ matrix.node-version }}
             - name: Cache npm and makecode
-              uses: actions/cache@v2
+              uses: actions/cache@v3
               with:
                   path: |
                       ~/.npm
                       ~/.pxt/mkc-cache
                   key: ${{ runner.os }}-${{ hashFiles('pxt.json') }}-${{ hashFiles('mkc*json') }}
                   restore-keys: |
                       ${{ runner.os }}-
-            - name: npm install makecode@0.34.5
+            - name: npm install makecode@1.3.4
               run: |
-                  npm install -g makecode@0.34.5
-            - name: build js
+                  npm install -g makecode@1.3.4
+            - name: build hex file
               run: |
-                  makecode --java-script
-            - name: build hardware N3
-              run: |
-                  makecode --hw N3
+                  makecode

.github/workflows/makecode.yml

@@ -1,34 +1,53 @@
-## Microsoft MicroCode [https://aka.ms/microcode](https://aka.ms/microcode)
+## MicroCode (version 2)
 
-Microsoft MicroCode is an icon-based programming language and editor for young learners to code with the [BBC micro:bit V2](https://microbit.org). MicroCode allows you to program the micro:bit V2 with only an [Arcade shield accessory](#arcade-shields-for-microbit-v2) - _no other computer is required!_ If you prefer the web browser, there's also a MicroCode web app that connects to your micro:bit V2 over WebUSB.
+MicroCode is an icon-based programming language and editor for young learners to code with the [BBC micro:bit V2](https://microbit.org). MicroCode allows you to program the micro:bit V2 with only an [display shield accessory](https://makecode.microbit.org/pkg/microbit-apps/display-shield) - _no other computer is required!_
 
-Here's the classic micro:bit _Happy-A-button/Sad-B-button_ program in MicroCode:
+## Getting started with MicroCode
 
-![Happy sad program in microcode](./docs/images/generated/sample_smiley_buttons.png)
+### With hardware
 
-## Getting started
+To use MicroCode, you will need to:
 
--   **Read the [MicroCode user guide](https://microsoft.github.io/microcode/docs/manual)**
--   [try it now!](https://microsoft.github.io/microcode/)
+1. Get a micro:bit (v2) and one of the [display shields](https://makecode.microbit.org/pkg/microbit-apps/display-shield).
+2. Download the [microcode hex file](./assets/microcode-v2.hex) and copy it your micro:bit.
+3. Insert the micro:bit into the display shield, and make sure the combination is powered.
 
-## [Arcade shields](https://microsoft.github.io/microcode/docs/manual#arcade-shield) for micro:bit V2
+With the above hardware, in addition to the freely-available MicroCode software, you also
+can use these other free programming environments:
 
-There are various [Arcade shields](https://microsoft.github.io/microcode/docs/manual#arcade-shield) available on the market today, as shown below.
+-   create your own graphics with [MakeCode for micro:bit](https://makecode.microbit.org) and the [display shield extension](https://makecode.microbit.org/pkg/microbit-apps/display-shield)
+-   develop retro arcade games with [MakeCode Arcade](https://arcade.makecode.com)
 
-<img style="width: 40%" src="https://microsoft.github.io/microcode/assets/newbit-shield.png"></img>
+### With simulators (no hardware required)
 
-## Robot
+You can load this repo into [https://makecode.microbit.org/beta](https://makecode.microbit.org/beta) using the import button on the right-hand side of the home page via "Import URL". Enter [https://github.com/microbit-apps/microcode-v2](https://github.com/microbit-apps/microcode-v2) as the URL.
 
-MicroCode can also be used to [program and control a 2 wheeled rover robot](https://microsoft.github.io/microcode/docs/robot).
+## What's New?
 
-![robot line following](https://microsoft.github.io/microcode/docs/images/generated/sample_robot_line_follow.png){:class="sample"}
+-   MicroCode is built using [MakeCode for the micro:bit](https://makecode.microbit.org/beta), which
+    provides direct access to all the micro:bit APIs available through MakeCode
 
-<img style="width: 40%" src="https://microsoft.github.io/microcode/docs/images/cutebot.jpeg"></img>
+-   Decimal notation (instead of the 1-5 dots in MicroCode-classic)
+
+-   Math (+, -, \*, /) and comparison (=, !=, <, >) operators
+
+-   Uniform support for sensors
+
+-   Lots of changes to improve reliability
+
+## What happened to MicroCode-classic and its features?
+
+While we soon will retire the [MicroCode-classic](https://aka.ms/microcode) web site, we plan to bring back the following features from MicroCode-classic:
+
+-   Option to use 1-5 dots, instead of decimal notation, for beginners.
+-   Jacdac services
+-   Robot cars
+-   Localization
 
 ## Development
 
-To contribute to MicroCode, please read about [MicroCode development](./docs/develop.md).
+See [https://github.com/microbit-apps](https://github.com/microbit-apps) for more information on developing micro:bit apps such as MicroCode.
 
 ## Contributing
 
-This project welcomes contributions and suggestions.
+[This project](https://github.com/microbit-apps/microcode-v2) welcomes contributions and suggestions.