From: Jonas Hvid <mail@johv.dk>
Date: Sat, 14 Mar 2020 20:38:43 +0000 (+0100)
Subject: Improve build instructions in README
X-Git-Url: https://git.rrq.au/?a=commitdiff_plain;h=8bceaf6620b213b2ddc9344448494af6d97dfb27;p=rrq%2Fjonasforth.git

Improve build instructions in README
---

diff --git a/README.md b/README.md
index db57758..0eb41c6 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,27 @@
 # Building and running
 
-Assemble and run the executable:
+You can run JONASFORTH inside QEMU or on real hardware. If you want to run
+inside QEMU, you should have the following dependencies installed (assuming
+Arch Linux):
 
-    $ make main
-    $ ./main
-
-The `example.f` file contains an example that you can run with:
-
-    $ cat sys.f example.f | ./main
-
-## Running with UEFI
+    $ pacman -S qemu ovmf
 
-We are currently in the process of implementing support for running without
-Linux, by instead relying on UEFI. Eventually, this will be the only supported
-method of running the interpreter, but currently the UEFI-related code is
-isolated in the `uefi/` directory and does not yet contain an implementation of
-the main program.
+Then, to run a UEFI shell inside QEMU, run:
 
-You should have the following dependencies installed (assuming Arch Linux):
+    $ make qemu
 
-    $ pacman -S qemu ovmf
+JONASFORTH will be available as `main` on `FS0:`. Thus, to run it, you can run
+the following command inside the UEFI shell:
 
-To run a UEFI shell inside qemu, cd to `uefi/` and run:
+    Shell> fs0:main
+    Ready.
+    S" Hello, World!" TELL
+    Hello World!
 
-    $ make run
+(Try typing in the code in `example.f` for something a little more
+interesting.)
 
-### Running on real hardware
+## Running on real hardware
 
 * [ ] This is not supported yet