From 52bd34a03dbf4a9256583eb0a65684575af052fe Mon Sep 17 00:00:00 2001
From: n loewen <nick@nloewen.com>
Date: Mon, 7 Aug 2023 10:55:41 +0100
Subject: [PATCH] Rename scripts for running assembler and cpu, to make their
 purpose clearer from just the filenames

---
 package.json                      |  8 ++++----
 assemble.js => run-assembler.js   |  4 ++--
 assemble-and-run.js => run-cpu.js | 12 ++++++++++--
 3 files changed, 16 insertions(+), 8 deletions(-)
 rename assemble.js => run-assembler.js (83%)
 rename assemble-and-run.js => run-cpu.js (68%)

diff --git a/package.json b/package.json
index e577f80..477a338 100644
--- a/package.json
+++ b/package.json
@@ -1,10 +1,10 @@
 {
   "name": "paper-computer",
   "scripts": {
-    "rundisplay": "node assemble-and-run.js run",
-    "rundebug": "node assemble-and-run.js debug",
-    "asm": "node assemble.js run",
-    "asmdebug": "node assemble.js debug",
+    "rundisplay": "node run-cpu.js run",
+    "rundebug": "node run-cpu.js debug",
+    "asm": "node run-assembler.js run",
+    "asmdebug": "node run-assembler.js debug",
     "jsdoc": "./node_modules/.bin/jsdoc"
   },
   "devDependencies": {
diff --git a/assemble.js b/run-assembler.js
similarity index 83%
rename from assemble.js
rename to run-assembler.js
index 083c665..f1cc371 100644
--- a/assemble.js
+++ b/run-assembler.js
@@ -1,5 +1,5 @@
-// Run:   `node assemble.js run assembly.asm`
-// Debug: `node assemble.js debug assembly.asm`
+// Run:   `node run-assembler.js run assembly.asm`
+// Debug: `node run-assembler.js debug assembly.asm`
 
 const fs = require('fs');
 const assembler = require('./assembler.js');
diff --git a/assemble-and-run.js b/run-cpu.js
similarity index 68%
rename from assemble-and-run.js
rename to run-cpu.js
index 1a535fa..4f50330 100644
--- a/assemble-and-run.js
+++ b/run-cpu.js
@@ -1,5 +1,13 @@
-// Run:   `node assemble-and-run.js run assembly.asm`
-// Debug: `node assemble-and-run.js debug assembly.asm`
+// Run:   `node run-cpu.js run assembly.asm`
+// Debug: `node run-cpu.js debug assembly.asm`
+
+// TODO: allow running pre-compiled machine code.
+//
+// i'm thinking of an interface like this...
+//
+// $ ./run-cpu -mc code.bin
+// $ ./run-cpu code.asm
+// $ ./run-cpu --debug code.asm
 
 const fs = require('fs');
 const computer = require('./simulator.js');