diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 5 insertions, 11 deletions
@@ -4,22 +4,16 @@ Alee is a portable and concise Forth implementation in modern C++. Its primary aims are for reduced program size and execution efficiency. Portability includes bare-metal platforms, with intentions to support microcontrollers with kilobytes of memory. -## Built-in words +## Compatibility -``` -drop dup swap pick rot >r r> -here allot const imm @ ! : ; ( -+ - * / % -= < -& | ^ << >> -sys -``` +A base dictionary is being built following the "core" [glossary](https://forth-standard.org/standard/core). Progress on implementation of these words is documented in `compat.txt`. -The `sys` word links to a C++ function for user-defined functionality. +A `sys` is available which links to a C++ function for user-defined functionality. ## Building Alee requires `make` and a C++17-compatible compiler. -To compile, simply run the `make` command. The resulting binary, `alee`, runs a read-eval-print loop. +To compile, simply run the `make` command. This will produce a library, `libalee.a`, as well as a REPL binary named `alee`. +A `small` target exists that optimizes the build for size. |