aboutsummaryrefslogtreecommitdiffstats
path: root/readme.md
diff options
context:
space:
mode:
authordan <[email protected]>2023-05-25 11:33:14 -0400
committerdan <[email protected]>2023-05-25 11:33:14 -0400
commit742bcacc541e76ea2a982a8f14aafe48aae33dec (patch)
tree5141b2db71b1cf660d1aefea7031fee9a84c97c8 /readme.md
parent40e23d550506659f7a33057bbbc23cb1cf0632f1 (diff)
downloadforth-742bcacc541e76ea2a982a8f14aafe48aae33dec.tar.gz
forth-742bcacc541e76ea2a982a8f14aafe48aae33dec.tar.bz2
forth-742bcacc541e76ea2a982a8f14aafe48aae33dec.zip
docs: update readme.md ; add run-rlwrap makefile command; add rlwrap completions file
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md15
1 files changed, 10 insertions, 5 deletions
diff --git a/readme.md b/readme.md
index bcc8cad..42a0877 100644
--- a/readme.md
+++ b/readme.md
@@ -2,9 +2,14 @@ Forth-style Stack Language with C and JS implementations.
JS implementation can be run by opening index.html in a web browser or running `node forth.js`.
-C implementation can be compiled with gcc (`gcc forth.c -o forth`) and then run `./forth`.
+Assuming you have gcc and make installed, the C implementation can be built with `make build`, then run with `./forth`.
+
+If you also have rlwrap installed, you can run `make run-rlwrap`, to get completions, history, and more pleasant line-editing.
+
+_Be aware:_
+
+ - Neither implementation is finished
+ - The instruction sets have _different_ missing features
+ - This is a toy language, not intended for serious use
+
-Be aware:
-- Neither implementation is finished
-- The instruction sets have _different_ missing features
-- This is a toy language, not intended for serious use