summaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'README.org')
-rw-r--r--README.org26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.org b/README.org
index 61795d7..2a600c4 100644
--- a/README.org
+++ b/README.org
@@ -1 +1,27 @@
* libfud
+
+** Design Principles
+
++ Full control over allocations, even the default allocator.
++ Zero exceptions, zero exceptions to zero exceptions.
++ Assertions in production release for invariants.
++ Configurable run-time assertions for indexing.
++ Safe API for users intolerant to run-time assertions for indexing.
++ Readable, understandable code.
++ Minimize undefined behavior in the API to a subset which is only decidable at
+ run-time.
++ Minimize runtime undefined behavior as much as possible.
+
+** Relatively mature features
+
++ Statically sized arrays
++ String Views
+
+** Unstable features
+
++ Customizable allocator model
++ Dynamically sized vectors taking an allocator
++ Dynamically sized strings taking an allocator
++ Unicode support with UTF8 encoding
++ Formatting à la =std::format=
++ Wrappers around C files