You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-14Lines changed: 24 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,22 +12,32 @@ It contains three tools:
12
12
13
13
## Usage
14
14
15
-
### Running in CodeSandbox
15
+
### Reccomended: Pre-compiled binaries
16
+
17
+
Pre-compiled binaries (executibles) are available for [common Windows and Linux platforms](#supported-platforms). Download them from the **[releases page](https://github.com/RandomSearch18/rusty_man_computer/releases/latest)**.
18
+
19
+
Then you can run the examples below (adapting the binary name to match the name of the file you've downloaded). For example:
I'd suggest renaming the binary file to `rusty-man-computer` or `rusty-man-computer.exe` (on Windows) to make things easier to type.
26
+
27
+
### Try it online: Run in CodeSandbox
16
28
17
29
You can try Rusty-Man Computer in your browser by visiting the **[💻 CodeSandbox demo](https://codesandbox.io/p/github/RandomSearch18/rusty_man_computer/)**.
18
30
19
31
If you see "Setup in progress" in the top left of the CodeSandbox UI, it's building a microVM image for you. You'll have to wait for this to complete (you can click on it to see progress). You _might_ have to refresh after it's finished building.
20
32
21
33
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 :D
22
34
23
-
### Pre-compiled binaries
24
-
25
-
At the moment, `cargo run` is the recommended way to run the app, but pre-compiled binaries are also available for [some platforms](#supported-platforms). Download them from the **[releases page](https://github.com/RandomSearch18/rusty_man_computer/releases/latest)**.
35
+
### Alternative: Run using Cargo
26
36
27
-
Then, you can directly run the binary, following the examples below, e.g.
37
+
If you have [Rust installed](https://rust-lang.org/tools/install/), you can run the programs by cloning this repository and using `cargo run`, e.g.
28
38
29
-
```sh
30
-
rusty-man-computer --ram demos/add.bin
39
+
```bash
40
+
cargo run --bin rusty_man_computer -- demos/add.bin
31
41
```
32
42
33
43
### Running the demo programs
@@ -39,7 +49,7 @@ Credit: Peter L Higginson, <https://peterhigginson.co.uk/lmc/>
39
49
> Output the sum of two numbers
40
50
41
51
```bash
42
-
cargo run --bin rusty_man_computer -- --ram demos/add.bin
52
+
rusty-man-computer --ram demos/add.bin
43
53
```
44
54
45
55
#### Addition and subtraction
@@ -51,23 +61,23 @@ Credit: Peter L Higginson, <https://peterhigginson.co.uk/lmc/>
51
61
> and the third minus the first
52
62
53
63
```bash
54
-
cargo run --bin rusty_man_computer -- --ram demos/add-subtract.bin
64
+
rusty-man-computer --ram demos/add-subtract.bin
55
65
```
56
66
57
67
#### Basic ASCII characters
58
68
59
69
Credit: Peter L Higginson, <https://peterhigginson.co.uk/lmc/>
60
70
61
71
```bash
62
-
cargo run --bin rusty_man_computer -- --ram demos/ascii.bin
72
+
rusty-man-computer --ram demos/ascii.bin
63
73
```
64
74
65
75
#### Basic ASCII character table
66
76
67
77
Credit: Peter L Higginson, <https://peterhigginson.co.uk/lmc/>
68
78
69
79
```bash
70
-
cargo run --bin rusty_man_computer -- --ram demos/ascii_table.bin
0 commit comments