diff options
authorPřemysl Janouch <p.janouch@gmail.com>2016-12-22 23:40:30 +0100
committerPřemysl Janouch <p.janouch@gmail.com>2016-12-22 23:40:30 +0100
commit99330e88f23a7e5aa0758bb9c934db395950ab2d (patch)
parentea69cc7d9eecbaab1d3b63868b1af959050db5eb (diff)
Update READMEs
2 files changed, 9 insertions, 3 deletions
diff --git a/README.adoc b/README.adoc
index 660c38c..e04e8bd 100644
--- a/README.adoc
+++ b/README.adoc
@@ -29,8 +29,9 @@ Usage
./bfc-amd64-linux [INPUT-FILE] [OUTPUT-FILE]
-When no input file is specified, stdin is used. Similarly, the default output
-filename is a.out. The resulting file can be run on the target platform.
+When no input file is specified, standard input is used. Similarly, the default
+output filename is `a.out`. After the compilation, the resulting file can be
+run on the target platform.
Contributing and Support
diff --git a/interpreters/README.adoc b/interpreters/README.adoc
index ecde608..11e45d3 100644
--- a/interpreters/README.adoc
+++ b/interpreters/README.adoc
@@ -9,7 +9,12 @@ sophistication, from the simplest approach to an optimizing JIT compiler:
* `bf-jit-unsafe.c` abolishes all boundary checks when moving across the tape
* `bf-jit-unsafe-opt.c` makes use of immediate offsets to modify values
-I recommend using a tool such as 'meld' to view the differences.
+I recommend using a tool such as _meld_ to view the differences.
Just run `make` in this directory to have them all built, and append
`CPPFLAGS=-DDEBUG` to get dumps of the IR for the more sophisticated JITs.
+The interpreters take the program on standard input and read characters
+directly from the terminal device, so to run a simple `cat`-like program,
+you can do:
+ $ echo ',[.,]' | ./bf