commit e99a36bd3cefac12636b6c1a35b3373d3bbac3ec
parent 4c7643decdd8efd12ddafcbfea21e4098b825b57
Author: Luxferre <lux@ferre>
Date: Thu, 11 Aug 2022 15:39:22 +0300
some docs corrections
Diffstat:
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
@@ -133,7 +133,7 @@ Please also note that Equi doesn't specify any graphical or sound output capabil
Being a purely PC-oriented low-level runtime/programming environment, Equi has the reference implementation emulator/VM written in C (ANSI C89 standard), `equi.c`, compilable and runnable on all the systems supporting standard I/O. Note that, for portability reasons, this emulator:
- only implements three ports for `P` instruction: 0 as an echo port (returns passed parameters as corresponding result values), 1 as a random port (returns two random values in the results in the range between the two parameter values) and 2 as a CRC16 calculation port for a given memory location and its length, for any other port value it outputs its parameters to the standard error stream and puts three 0x0000 values back onto the stack,
-- doesn't implement non-blocking key input (the ',' instruction is identical to blocking key input instruction `?`),
+- doesn't implement non-blocking key input (the `,` instruction is identical to blocking key input instruction `?`),
- sandboxes the `{` and `}` operations using the file you supply in the command-line parameter. If you don't supply the file, these operations will effectively do nothing except putting 0x0000 (success status) onto the stack.
The source code file should compile using any mainstream C compiler with C89 support, like GCC/DJGPP, Clang, TCC etc. However, it is also being developed to be compilable with CC65 compiler for targets like Apple II or Atari 800. All the machine/target specific configuration is done at compile time, using compiler command-line switches. Here are the instructions to build Equi using different known C compilers.
@@ -142,9 +142,9 @@ The following constants can be adjusted at compile time:
- `STACK_SIZE` - main and return stacks size in bytes (65535 max);
- `LIT_STACK_SIZE` - literal stack size in bytes (255 max);
-- `GPD_AREA_START` - GPD area start address in the virtual RAM;
-- `CMD_BUF_START` - command buffer start address in the virtual RAM;
-- `CMD_BUF_SIZE` - command buffer size in bytes (65535 max).
+- `GPD_AREA_SIZE` - GPD area size in bytes;
+- `CMD_BUF_SIZE` - command buffer size in bytes (65535 max);
+- `CLT_ENTRIES_MAX` - size (in entries) of the compilation lookup table (CLT), each entry taking exactly 4 bytes.
Please keep in mind that the reference implementation code primarily serves as a, well, reference on how the specification should be implemented, so it emphasizes on code portability and readability over performance whenever such a choice arises.
