aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordam <dam@gudinoff>2024-05-29 12:52:14 +0100
committerdam <dam@gudinoff>2024-08-29 10:03:39 +0100
commitc57f2b97285c44241c6e73fad8705f17fc32a320 (patch)
tree7fc28cc09903f28f1945135e1dc656c6d2fad5fc /README.md
parent4383bcc293f8c9697ce54cec951e3bfc408a6c86 (diff)
downloadjai-modules-c57f2b97285c44241c6e73fad8705f17fc32a320.tar.zst
jai-modules-c57f2b97285c44241c6e73fad8705f17fc32a320.zip
Small tweaks on the readme file.
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 12 insertions, 5 deletions
diff --git a/README.md b/README.md
index b41dc9f..13179e6 100644
--- a/README.md
+++ b/README.md
@@ -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