From 7fed47983d7090926e79463fbd036835610eca21 Mon Sep 17 00:00:00 2001
From: empathicqubit <empathicqubit@entan.gl>
Date: Fri, 30 Apr 2021 01:05:55 -0400
Subject: [PATCH] Add instructions about when to preload the ROM vs not.

---
 pool.lua                 | 8 ++++++++
 tools/status-overlay.lua | 4 ++++
 2 files changed, 12 insertions(+)

diff --git a/pool.lua b/pool.lua
index ecfdd90..0d59a64 100644
--- a/pool.lua
+++ b/pool.lua
@@ -10,8 +10,16 @@ local hasThreads =
 		config.NeatConfig.Threads > 1
 local Runner = nil
 if hasThreads then
+	local warn = '========== When using threads, the ROM file to use comes from config.lua. Also, you do not need to start any ROM in the parent process.'
+	io.stderr:write(warn)
+	print(warn)
+
     Runner = dofile(base.."/runner-wrapper.lua")
 else
+	local warn = '========== The ROM must already be running when you only have one thread.'
+	io.stderr:write(warn)
+	print(warn)
+
     Runner = dofile(base.."/runner.lua")
 end
 
diff --git a/tools/status-overlay.lua b/tools/status-overlay.lua
index e5d6f65..f50e56d 100644
--- a/tools/status-overlay.lua
+++ b/tools/status-overlay.lua
@@ -2,6 +2,10 @@ local base = string.gsub(@@LUA_SCRIPT_FILENAME@@, "(.*[/\\])(.*)", "%1").."/.."
 
 local set_timer_timeout, memory, memory2, gui, input, bit = set_timer_timeout, memory, memory2, gui, input, bit
 
+local warn = '========== The ROM must be running before running this script'
+io.stderr:write(warn)
+print(warn)
+
 local util = dofile(base.."/util.lua")
 local mem = dofile(base.."/mem.lua")
 local spritelist = dofile(base.."/spritelist.lua")