aboutsummaryrefslogtreecommitdiff
path: root/modules/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'modules/README.md')
-rw-r--r--modules/README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/modules/README.md b/modules/README.md
index 13179e6..0f8c159 100644
--- a/modules/README.md
+++ b/modules/README.md
@@ -3,13 +3,13 @@ jai-modules
Modules for the language being developed by Thekla, Inc.
-Available at https://github.com/gudinoff/jai-modules
+Available at <https://source.gudinoff.com>
# Saturation
This module provides basic integer [saturation arithmetic](https://en.wikipedia.org/wiki/Saturation_arithmetic) procedures: `add`, `sub`, `mul`, and `div`.
-These procedures accept any of the built-in integer types and adjust the output accordingly, e.g., adding an `u8` with an `s16` results in an `s16`;
-All procedures return a flag signaling if the result is saturated and, additionally, the division procedure returns the remainder;
+These procedures accept any of the built-in integer types and adjust the output accordingly, e.g., adding an `u8` with an `s16` results in an `s16`.
+All procedures return a flag signaling if the result is saturated and, additionally, the division procedure returns the remainder.
Branch-free procedures are included for the x64 architecture. These may be used by setting the `PREFER_BRANCH_FREE_CODE` module argument, or by setting `prefer_branch_free_code` on each function call. These should speed things up, specially when using signed values. Some benchmarks are included on the tests file.
# TUI
@@ -18,6 +18,7 @@ A simple terminal user interface module that provides basic functionalities simi
Usefull for creating simple terminal-based apps that require user input.
View `snake.jai` for an example.
It has been tested on the following terminal emulators:
+
- [GNOME Terminal](https://en.wikipedia.org/wiki/GNOME_Terminal)
- [kitty](https://en.wikipedia.org/wiki/Kitty_(terminal_emulator))
- [Konsole](https://en.wikipedia.org/wiki/Konsole)