diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | README.md | 17 |
2 files changed, 12 insertions, 6 deletions
diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 30bcfa4..0000000 --- a/.gitignore +++ /dev/null @@ -1 +0,0 @@ -.build/ @@ -1,14 +1,19 @@ -Readme -====== +jai-modules +=========== + Modules for the language being developed by Thekla, Inc. -## Saturation +Available at https://github.com/gudinoff/jai-modules + +# 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; 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 +# TUI + A simple terminal user interface module that provides basic functionalities similar to the [ncurses library](https://en.wikipedia.org/wiki/Ncurses). Usefull for creating simple terminal-based apps that require user input. View `snake.jai` for an example. @@ -20,10 +25,12 @@ It has been tested on the following terminal emulators: - [xterm](https://en.wikipedia.org/wiki/Xterm) - [Windows Terminal](https://en.wikipedia.org/wiki/Windows_Terminal) -## UTF8 +# UTF8 + Basic operations over UTF8 encoded strings. # License + Licensed under MIT or ISC. SPDX-License-Identifier: MIT OR ISC |