summaryrefslogtreecommitdiff
path: root/libtnsl/READEME.md
diff options
context:
space:
mode:
Diffstat (limited to 'libtnsl/READEME.md')
-rw-r--r--libtnsl/READEME.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/libtnsl/READEME.md b/libtnsl/READEME.md
new file mode 100644
index 0000000..32cff9a
--- /dev/null
+++ b/libtnsl/READEME.md
@@ -0,0 +1,50 @@
+# libts
+
+The official implimentation of the TNSL Standard Library
+
+libts provides the following language features:
+* Type and method resolution
+* Basic input and output
+* Standard algorithms
+* Standard data containers
+* Basic platform identification
+* Time resolution
+
+More information on these features can be found in the specification under libts.txt
+
+---
+## Provided Sub-modules
+
+libts provides the ts base module and the following sub-modules to address each feature:
+* algorithm
+ * Algorithms. Also contains the math sub-module for basic math operations.
+* box
+ * Data containers (vector, map, etc.)
+* io
+ * Input and output
+* reflect
+ * Type reflection and method resolution
+* time
+ * Time related functions
+
+Each sub-module should have its own README to address features
+
+---
+ Copyright 2021 Kyle Gunger
+
+ Dual licenced under the CDDL 1.0 and BSD 3-Clause licences.
+
+ This file may only be used in accordance with one of the two
+ licences. You should have recieved a copy of each licence with
+ the source code. In the event that you did not recieve a copy
+ of the licences, they may be found at the following URLs:
+
+ CDDL 1.0:
+ https://opensource.org/licenses/CDDL-1.0
+
+ BSD 3-Clause:
+ https://opensource.org/licenses/BSD-3-Clause
+
+ THIS SOFTWARE/SOURCE CODE IS PROVIDED "AS IS" WITH NO
+ WARRENTY, GUARANTEE, OR CLAIM OF FITNESS FOR ANY PURPOSE
+ EXPRESS OR IMPLIED