Merge pull request #9 from RandomSearch18/draft/great-mccarthy

Add support for demos in the browser using CodeSandbox

Author: RandomSearch18

.codesandbox/tasks.json

@@ -0,0 +1,7 @@
+{
+  // These tasks will run in order when initializing your CodeSandbox project.
+  "setupTasks": [],
+
+  // These tasks can be run from CodeSandbox. Running one will open a log in the app.
+  "tasks": {}
+}

.devcontainer/devcontainer.json

@@ -0,0 +1,31 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/rust
+{
+	"name": "Rust",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/rust:1-1-bullseye"
+
+	// Use 'mounts' to make the cargo cache persistent in a Docker Volume.
+	// "mounts": [
+	// 	{
+	// 		"source": "devcontainer-cargo-cache-${devcontainerId}",
+	// 		"target": "/usr/local/cargo",
+	// 		"type": "volume"
+	// 	}
+	// ]
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "rustc --version",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for more information:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+# https://containers.dev/guide/dependabot
+
+version: 2
+updates:
+ - package-ecosystem: "devcontainers"
+   directory: "/"
+   schedule:
+     interval: weekly

README.md

@@ -9,17 +9,13 @@ It contains two tools:
 - **`rusty_man_computer`** Is the main program. It reads a binary file containing assembled LMC code and runs it.
 - **`bin_creator`** is a utility that lets you paste in the contents of LMC's memory (from the online simulator), which it will convert to a binary file (which can be executed by `rusty_man_computer`).
 
-## Screenshots
-
-### Printing every ASCII character
-
-This screenshot only shows the last few clock cycles, after all the characters have been printed.
+## Usage
 
-Each clock cycle, the contents of the registers are shown on the first line, the next line is the output, and then the contents of memory is printed, formatted in the same way as the online simulator (left to right, and then down).
+### Running in CodeSandbox
 
-![Screenshot of some of the output from the emulator running in a terminal](assets/terminal-demo-1.png)
+You can try Rusty-Man Computer in your browser by visiting the **CodeSandbox demo**. (TODO: Add link)
 
-## Usage
+Once CodeSandbox has loaded, press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>\`</kbd> to open a new terminal, where you can use `cargo run` to run the [demo programs](#running-the-demo-programs) below.
 
 ### Pre-compiled binaries
 
@@ -106,6 +102,16 @@ cargo run --bin rusty_man_computer -- --ram my_program.bin
 - `--help` (`-h`) prints the help message, which shows a list of command-line arguments.
 - `--version` (`-V`) prints the program name and version.
 
+## Screenshots
+
+### Printing every ASCII character
+
+This screenshot only shows the last few clock cycles, after all the characters have been printed.
+
+Each clock cycle, the contents of the registers are shown on the first line, the next line is the output, and then the contents of memory is printed, formatted in the same way as the online simulator (left to right, and then down).
+
+![Screenshot of some of the output from the emulator running in a terminal](assets/terminal-demo-1.png)
+
 ## Features
 
 Rusty-Man Computer shows the whole state of the computer at the end of every clock cycle, including the contents of the registers, all memory values, the output, and if a branch instruction has been called. This verbose output should make it easy to see what the emulator is doing, and to track your code as it runs.