diff --git a/.github/workflows/start-site.yml b/.github/workflows/start-site.yml index bb906f42..1af3a78b 100644 --- a/.github/workflows/start-site.yml +++ b/.github/workflows/start-site.yml @@ -31,6 +31,7 @@ jobs: - run: cp ./scratch-microbit-more/site/index.html ./scratch-gui/build/index.html - run: cp ./scratch-microbit-more/site/favicon.ico ./scratch-gui/build/static/favicon.ico - run: cp -r ./scratch-microbit-more/dist ./scratch-gui/build/dist + - run: cp ./scratch-microbit-more/site/donation.html ./scratch-gui/build/donation.html - uses: peaceiris/actions-gh-pages@v3 with: deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} diff --git a/README.md b/README.md index bf096f69..4e0e70be 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,110 @@ -# mbit-more -Another micro:bit extension for Scratch3. +

scratch-microbit-more

+

+ Version + + Documentation + + + Maintenance + + + License: MIT + +

+ +> Full-functional extension of micro:bit for Scratch3 + +### ✨ Open [Microbit More Web-App](https://yokobond.github.io/scratch-microbit-more) + +### 🏠 [Homepage](https://lab.yengawa.com/project/scratch-microbit-more/) + +## Setup Development Environment + +Download the Scratch3 repositories according to the supporsed directory configuration. + +``` +. +|-- scratch-microbit-more +|-- scratch-vm +|-- scratch-gui +``` + +Install node modules and setup to use local repo for development. + +```sh +cd ./scratch-microbit-more +npm install +npm run setup:local +npm run install:local +``` + +## Install into Scratch3 + +To install this extention into your selfbuild Scratch3, execute `scripts/install.js` with options as follows. + +```sh +node ./scripts/install.js --gui="../scratch-gui" --vm="../scratch-gui/node_modules/scratch-vm" --url="https://yokobond.github.io/scratch-microbit-more/dist/microbitMore.mjs" +``` + +- --gui : location of scratch-gui from current dir. +- --vm : location of scratch-vm form current dir. +- --url : URL to get its module as a lodable extension for Xcratch. + +**CAUTION:** This script will change '`extension default`' in `scratch-gui/src/lib/libraries/extensions/index.jsx` as follows. + +change from the original code + +```js +export default [...]; +``` + +to + +```js +const extensions = [...]; +export default extensions; +``` + +It may break installation mechanism of the other extensions. + + +## Xcratch Module Building + +Build module as loadable extension for [Xcratch](https://github.com/yokobond/xcratch). + +```sh +node ./scripts/build.js --name=microbitMore --block="./src/block" --entry="./src/entry" --vm="../scratch-vm" --gui="../scratch-gui" --output="./dist" +``` + +- --name: name of the module file (without '.mjs'). +- --block : location of block files from current dir. +- --entry : location of entry files from current dir. +- --gui : location of scratch-gui from current dir. +- --vm : location of scratch-vm form current dir. +- --output : location to save module form current dir. + +## Author + +👤 **Koji Yokokawa** + +* Website: http://www.yengawa.com/ +* Github: [@yokobond](https://github.com/yokobond) + +## 🤝 Contributing + +Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/yokobond/scratch-microbit-more/issues). You can also take a look at the [contributing guide](https://github.com/yokobond/scratch-microbit-more/blob/master/CONTRIBUTING.md). + +## Show your support + +Give a ⭐️ if this project helped you! + +[Donate](https://yokobond.github.io/scratch-microbit-more/donation.html) if this project is worth for you. + + +## 📝 License + +Copyright © 2020 [Koji Yokokawa](https://github.com/yokobond).
+This project is [MIT](https://github.com/yokobond/scratch-microbit-more/blob/trunk/LICENSE) licensed. + +*** +_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_ \ No newline at end of file diff --git a/site/donation.html b/site/donation.html new file mode 100644 index 00000000..4be0aa35 --- /dev/null +++ b/site/donation.html @@ -0,0 +1,80 @@ + + + + + + + + + + +
+
+

Donation for MicrobitMore

+

Please purchase it for donation to MicrobitMore + project.

+
+ USD +
+
+
+
+ + + \ No newline at end of file