Merge pull request #16 from WilliamMayor/master

Add CodeGuild instructions

Author: WilliamMayor

.gitignore

@@ -1 +1,2 @@
 *.swp
+.vagrant

CODEGUILD.md

@@ -0,0 +1,60 @@
+# micro:edit
+
+An online Python editor for the micro:bit.
+
+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 :)
+
+## Making Changes
+
+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:
+
+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.
+
+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.
+
+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.
+
+To make changes you'll need to clone your fork. This might require running something like this on the command line:
+
+    $ git clone https://github.com/YOUR_USERNAME/PythonEditor
+
+This will have downloaded the repo to your computer. Let's now get vagrant up and running by doing:
+
+    $ cd PythonEditor
+    $ vagrant up
+
+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:
+
+    $ vagrant ssh
+
+And now we can serve the website locally:
+
+    $ cd /vagrant
+    $ ./show.sh
+
+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.
+
+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!
+
+
+## Sharing Changes
+
+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:
+
+    $ git add CHANGED_FILE CHANGED_FILE
+    $ git commit -m 'DESCRIPTION_OF_CHANGES'
+    $ git push origin master
+
+If you don't know what the `git add` or `git commit` instructions are doing, ask around!
+
+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.
+
+
+## Improvements
+
+- Add a simulator to the editor
+    - Here's an example of a micro:bit simulator running Python: https://tools.withcode.uk/create/
+    - Here's the source code: https://github.com/pddring/createwithcode
+    - Let's add this simulator into this editor
+- Make the website nicer
+- Make these instructions nicer

Vagrantfile

@@ -0,0 +1,20 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+Vagrant.configure("2") do |config|
+    config.vm.box = "ubuntu/trusty64"
+    config.vm.network "private_network", ip: "192.168.33.10"
+    config.vm.provision "shell", inline: <<-SHELL
+        add-apt-repository ppa:jonathonf/python-3.6
+        apt-get update
+        apt-get upgrade --assume-yes
+        apt-get install --assume-yes \
+            git \
+            vim \
+            python3.6
+        apt-get autoremove --assume-yes
+    SHELL
+    config.vm.provision "shell", privileged: false, inline: <<-SHELL
+        cd /vagrant
+        git submodule update --init --recursive
+    SHELL
+end

show.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
 echo "http://localhost:8000/editor.html"
-python3 -m http.server
+python3 -m http.server --bind 0.0.0.0