Skip to content

Commit 0464bd6

Browse files
WilliamMayorWilliamMayor
authored
Merge pull request #17 from jamesblissett/master
Add simulator to editor page
2 parents 4c3521f + d403073 commit 0464bd6

File tree

99 files changed

+96286
-49750
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+96286
-49750
lines changed

‎AUTHORS

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
Nicholas H.Tollervey (@ntoll)
2-
Damien P.George (@dpgeorge)
1+
Nicholas H.Tollervey (@ntoll)
2+
Damien P.George (@dpgeorge)

‎CHANGELOG

Lines changed: 78 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,78 @@
1-
0.1.0
2-
-----
3-
4-
* Add "Experimental" background image.
5-
* Update help pages to reflect the latest changes.
6-
* Add awareness of versioning and related manifest when available.
7-
* Add file load button with drag and drop capabilities.
8-
9-
0.0.10
10-
------
11-
12-
* Fix outstanding block related gremlins (with tests).
13-
14-
0.0.9
15-
-----
16-
17-
* Add zoom to blocks (thanks Carlos).
18-
* Fix next-block on panic and reset blocks (thanks again Carlos).
19-
* Fix GIT submodule misconfiguration (thanks again [again] Carlos).
20-
* Disable code snippets when blockly is active.
21-
* Update documentation as per the above changes.
22-
23-
0.0.8
24-
-----
25-
26-
* Add blockly support (requires GIT sub-modules).
27-
* Add config object containing translation strings.
28-
* Add feature flags to the config object.
29-
* Check for size of Python script before flashing (added tests for this too).
30-
* Move editor instantiation to within the HTML.
31-
* Updated help to include latest UI changes.
32-
* Updated README in light of changes above.
33-
34-
0.0.7
35-
-----
36-
37-
* If there's unsaved work, ask user for confirmation if moving away from editor.
38-
* Add save button to download raw Python script.
39-
* Add drag to load for Python scripts and hex files.
40-
41-
0.0.6
42-
-----
43-
44-
* Remove TouchDevelop specific elements.
45-
* Make a stand-alone version of the editor.
46-
* Simplification of the UI.
47-
* Add a "share" button to create a tiny URL to point at the current script.
48-
* Use query strings to override the script name, comment and code.
49-
* Update to the latest version of MicroPython:
50-
- Various minor refactors.
51-
- Audio
52-
- Speech
53-
- Radio
54-
- input() builtin
55-
* Documentation work / tidy up.
56-
57-
0.0.5
58-
-----
59-
60-
* Update to the latest version of MicroPython:
61-
- Various minor code refactors.
62-
- More efficient ticker (reduces overhead of display update by 90%).
63-
- Add builtin set and frozenset types (from core Python).
64-
- Don't show SystemExit or KeyboardInterrupt exceptions on the display.
65-
* Update bug in editor that caused the status icon not to update to cloud.
66-
* Added test script here: https://stage.microbit.co.uk/hoqumw
67-
* Revised button-press code to be simpler.
68-
* Minor documentation updates.
69-
70-
0.0.4
71-
-----
72-
73-
Initial tested public release.
74-
75-
0.1-0.3
76-
-------
77-
78-
Private test versions.
1+
0.1.0
2+
-----
3+
4+
* Add "Experimental" background image.
5+
* Update help pages to reflect the latest changes.
6+
* Add awareness of versioning and related manifest when available.
7+
* Add file load button with drag and drop capabilities.
8+
9+
0.0.10
10+
------
11+
12+
* Fix outstanding block related gremlins (with tests).
13+
14+
0.0.9
15+
-----
16+
17+
* Add zoom to blocks (thanks Carlos).
18+
* Fix next-block on panic and reset blocks (thanks again Carlos).
19+
* Fix GIT submodule misconfiguration (thanks again [again] Carlos).
20+
* Disable code snippets when blockly is active.
21+
* Update documentation as per the above changes.
22+
23+
0.0.8
24+
-----
25+
26+
* Add blockly support (requires GIT sub-modules).
27+
* Add config object containing translation strings.
28+
* Add feature flags to the config object.
29+
* Check for size of Python script before flashing (added tests for this too).
30+
* Move editor instantiation to within the HTML.
31+
* Updated help to include latest UI changes.
32+
* Updated README in light of changes above.
33+
34+
0.0.7
35+
-----
36+
37+
* If there's unsaved work, ask user for confirmation if moving away from editor.
38+
* Add save button to download raw Python script.
39+
* Add drag to load for Python scripts and hex files.
40+
41+
0.0.6
42+
-----
43+
44+
* Remove TouchDevelop specific elements.
45+
* Make a stand-alone version of the editor.
46+
* Simplification of the UI.
47+
* Add a "share" button to create a tiny URL to point at the current script.
48+
* Use query strings to override the script name, comment and code.
49+
* Update to the latest version of MicroPython:
50+
- Various minor refactors.
51+
- Audio
52+
- Speech
53+
- Radio
54+
- input() builtin
55+
* Documentation work / tidy up.
56+
57+
0.0.5
58+
-----
59+
60+
* Update to the latest version of MicroPython:
61+
- Various minor code refactors.
62+
- More efficient ticker (reduces overhead of display update by 90%).
63+
- Add builtin set and frozenset types (from core Python).
64+
- Don't show SystemExit or KeyboardInterrupt exceptions on the display.
65+
* Update bug in editor that caused the status icon not to update to cloud.
66+
* Added test script here: https://stage.microbit.co.uk/hoqumw
67+
* Revised button-press code to be simpler.
68+
* Minor documentation updates.
69+
70+
0.0.4
71+
-----
72+
73+
Initial tested public release.
74+
75+
0.1-0.3
76+
-------
77+
78+
Private test versions.

‎CODEGUILD.md

Lines changed: 60 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,60 @@
1-
# micro:edit
2-
3-
An online Python editor for the micro:bit.
4-
5-
This file is for students on the [Villiers Park](http://www.villierspark.org.uk/) Computer Science Course. Although the rest of you are allowed to read it too :)
6-
7-
## Making Changes
8-
9-
If you want to build new features into the editor you'll need a local copy of the code to change, as well as a way to test your changes. Here's how:
10-
11-
You'll need to make sure you've got [git](https://git-scm.com/), [VirtualBox](https://www.virtualbox.org/), and [Vagrant](https://www.vagrantup.com/) installed. They're all free and pretty easy to install.
12-
13-
Then you'll need to fork this repo (so you'll need a GitHub account, if you don't already have one). This is easy, just click the "Fork" button in the top right of this page.
14-
15-
You'll now have your own copy of the repository stored in your own account. You can make whatever changes you'd like to this copy; it's yours.
16-
17-
To make changes you'll need to clone your fork. This might require running something like this on the command line:
18-
19-
$ git clone https://github.com/YOUR_USERNAME/PythonEditor
20-
21-
This will have downloaded the repo to your computer. Let's now get vagrant up and running by doing:
22-
23-
$ cd PythonEditor
24-
$ vagrant up
25-
26-
This one might take a while, but when it's done there will be a virtual machine running on your computer with all the code inside. We can connect to the virtual machine like this:
27-
28-
$ vagrant ssh
29-
30-
And now we can serve the website locally:
31-
32-
$ cd /vagrant
33-
$ ./show.sh
34-
35-
If you now open this link: http://192.168.33.10:8000 you should see the editor. Except this one is running on your machine, so changes we make here will be seen on the website.
36-
37-
You can now edit the code and see the changes you make alter the local copy of the website. Start by changing something small to see if it works. Then think of a minor bugfix/improvement you can make and try that. When you're confident about making larger changes, go for it!
38-
39-
40-
## Sharing Changes
41-
42-
When you're done making changes you'll want to have them included in the CodeGuild version of the website (not just your own), and then maybe even the official BBC version. So first push your changes up to your fork:
43-
44-
$ git add CHANGED_FILE CHANGED_FILE
45-
$ git commit -m 'DESCRIPTION_OF_CHANGES'
46-
$ git push origin master
47-
48-
If you don't know what the `git add` or `git commit` instructions are doing, ask around!
49-
50-
Now your fork will have the changes, let's make a pull request to the main repo to have them included in the main site. You'll need to open your fork on the GitHub website and click the "New Pull Request" button. Hopefully you'll see a green bit of text that says "Able to merge", if so, click the "Create pull request" button, provide a description of the work you've done and alick "Create pull request" again. If instead you see a red error message, you'll have to fix the problems it talks about before your work can be merged.
51-
52-
53-
## Improvements
54-
55-
- Add a simulator to the editor
56-
- Here's an example of a micro:bit simulator running Python: https://tools.withcode.uk/create/
57-
- Here's the source code: https://github.com/pddring/createwithcode
58-
- Let's add this simulator into this editor
59-
- Make the website nicer
60-
- Make these instructions nicer
1+
# micro:edit
2+
3+
An online Python editor for the micro:bit.
4+
5+
This file is for students on the [Villiers Park](http://www.villierspark.org.uk/) Computer Science Course. Although the rest of you are allowed to read it too :)
6+
7+
## Making Changes
8+
9+
If you want to build new features into the editor you'll need a local copy of the code to change, as well as a way to test your changes. Here's how:
10+
11+
You'll need to make sure you've got [git](https://git-scm.com/), [VirtualBox](https://www.virtualbox.org/), and [Vagrant](https://www.vagrantup.com/) installed. They're all free and pretty easy to install.
12+
13+
Then you'll need to fork this repo (so you'll need a GitHub account, if you don't already have one). This is easy, just click the "Fork" button in the top right of this page.
14+
15+
You'll now have your own copy of the repository stored in your own account. You can make whatever changes you'd like to this copy; it's yours.
16+
17+
To make changes you'll need to clone your fork. This might require running something like this on the command line:
18+
19+
$ git clone https://github.com/YOUR_USERNAME/PythonEditor
20+
21+
This will have downloaded the repo to your computer. Let's now get vagrant up and running by doing:
22+
23+
$ cd PythonEditor
24+
$ vagrant up
25+
26+
This one might take a while, but when it's done there will be a virtual machine running on your computer with all the code inside. We can connect to the virtual machine like this:
27+
28+
$ vagrant ssh
29+
30+
And now we can serve the website locally:
31+
32+
$ cd /vagrant
33+
$ ./show.sh
34+
35+
If you now open this link: http://192.168.33.10:8000 you should see the editor. Except this one is running on your machine, so changes we make here will be seen on the website.
36+
37+
You can now edit the code and see the changes you make alter the local copy of the website. Start by changing something small to see if it works. Then think of a minor bugfix/improvement you can make and try that. When you're confident about making larger changes, go for it!
38+
39+
40+
## Sharing Changes
41+
42+
When you're done making changes you'll want to have them included in the CodeGuild version of the website (not just your own), and then maybe even the official BBC version. So first push your changes up to your fork:
43+
44+
$ git add CHANGED_FILE CHANGED_FILE
45+
$ git commit -m 'DESCRIPTION_OF_CHANGES'
46+
$ git push origin master
47+
48+
If you don't know what the `git add` or `git commit` instructions are doing, ask around!
49+
50+
Now your fork will have the changes, let's make a pull request to the main repo to have them included in the main site. You'll need to open your fork on the GitHub website and click the "New Pull Request" button. Hopefully you'll see a green bit of text that says "Able to merge", if so, click the "Create pull request" button, provide a description of the work you've done and alick "Create pull request" again. If instead you see a red error message, you'll have to fix the problems it talks about before your work can be merged.
51+
52+
53+
## Improvements
54+
55+
- Add a simulator to the editor
56+
- Here's an example of a micro:bit simulator running Python: https://tools.withcode.uk/create/
57+
- Here's the source code: https://github.com/pddring/createwithcode
58+
- Let's add this simulator into this editor
59+
- Make the website nicer
60+
- Make these instructions nicer

‎CONTRIBUTING.rst

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,41 @@
1-
Contributing to the Editor
2-
==========================
3-
4-
Hey! Many thanks for wanting to improve the browser based editor for
5-
MicroPython on the BBC micro:bit.
6-
7-
Contributions are welcome, without prejudice, from *anyone* irrespective of
8-
who you are. If you're thinking, "but that probably doesn't mean me", then we
9-
ESPECIALLY mean you. Good quality code and engagement with respect, humour and
10-
intelligence wins every time.
11-
12-
* If you're from a background which isn't well-represented in most geeky groups, get involved - *we want to help you make a difference*.
13-
* If you're from a background which *is* well-represented in most geeky groups, get involved - *we want your help making a difference*.
14-
* If you're worried about not being technical enough, get involved - *your fresh perspective will be invaluable*.
15-
* If you think you're an imposter, get involved.
16-
* If your day job isn't code, get involved.
17-
* This isn't a group of experts, just people. Get involved!
18-
* We are interested in educational, social and technical problems. If you are too, get involved.
19-
* This is a new community. *No-one knows what they are doing*, so, get involved.
20-
21-
We expect contributors to follow the Python Software Foundation's Code of
22-
Conduct: https://www.python.org/psf/codeofconduct/
23-
24-
Feedback may be given for contributions and, where necessary, changes will
25-
be politely requested and discussed with the originating author. Respectful
26-
yet robust argument is most welcome.
27-
28-
Finally, contributions are subject to the following caveat: the contribution
29-
was created by the contributor who, by submitting the contribution, is
30-
confirming that they have the authority to submit the contribution and place it
31-
under the license as defined in the LICENSE file found within this repository.
32-
33-
Checklist
34-
+++++++++
35-
36-
* Your code should be commented in *plain English* (British spelling).
37-
* If your contribution is for a major block of work and you've not done so
38-
already, add yourself to the AUTHORS file following the convention found
39-
therein.
40-
* Try to include tests!
41-
* Have fun!
1+
Contributing to the Editor
2+
==========================
3+
4+
Hey! Many thanks for wanting to improve the browser based editor for
5+
MicroPython on the BBC micro:bit.
6+
7+
Contributions are welcome, without prejudice, from *anyone* irrespective of
8+
who you are. If you're thinking, "but that probably doesn't mean me", then we
9+
ESPECIALLY mean you. Good quality code and engagement with respect, humour and
10+
intelligence wins every time.
11+
12+
* If you're from a background which isn't well-represented in most geeky groups, get involved - *we want to help you make a difference*.
13+
* If you're from a background which *is* well-represented in most geeky groups, get involved - *we want your help making a difference*.
14+
* If you're worried about not being technical enough, get involved - *your fresh perspective will be invaluable*.
15+
* If you think you're an imposter, get involved.
16+
* If your day job isn't code, get involved.
17+
* This isn't a group of experts, just people. Get involved!
18+
* We are interested in educational, social and technical problems. If you are too, get involved.
19+
* This is a new community. *No-one knows what they are doing*, so, get involved.
20+
21+
We expect contributors to follow the Python Software Foundation's Code of
22+
Conduct: https://www.python.org/psf/codeofconduct/
23+
24+
Feedback may be given for contributions and, where necessary, changes will
25+
be politely requested and discussed with the originating author. Respectful
26+
yet robust argument is most welcome.
27+
28+
Finally, contributions are subject to the following caveat: the contribution
29+
was created by the contributor who, by submitting the contribution, is
30+
confirming that they have the authority to submit the contribution and place it
31+
under the license as defined in the LICENSE file found within this repository.
32+
33+
Checklist
34+
+++++++++
35+
36+
* Your code should be commented in *plain English* (British spelling).
37+
* If your contribution is for a major block of work and you've not done so
38+
already, add yourself to the AUTHORS file following the convention found
39+
therein.
40+
* Try to include tests!
41+
* Have fun!

0 commit comments

Comments
 (0)