aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorClyne Sullivan <clyne@bitgloo.com>2022-08-06 21:57:56 -0400
committerClyne Sullivan <clyne@bitgloo.com>2022-08-06 21:57:56 -0400
commit30fd7bb79fe88aad8740543dd29a56b8f7b55a01 (patch)
tree58349c5de711d3bde75eb0802dc275945cca57e3 /README.md
parent630b2e6a22b9ecea8980db6e30f1851353022f71 (diff)
Add funreg.hpp
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 18 insertions, 2 deletions
diff --git a/README.md b/README.md
index 5ea5a47..c46b295 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,19 @@
-# funreg
+# funreg: Functional Memory-mapped Register I/O
+
+*funreg* provides a functional approach to operating on memory-mapped registers
+with zero overhead. This library primarily targets embedded firmware, where
+these types of operations are frequently encountered.
+
+What makes this library unique is its ability to carry out multiple register
+operations with a single function call, reducing this to a single register read
+and write. Further, registers can be organized into "groups": these groups can
+receive a list of operations for any of the contained registers, and will
+optimize down to a single read and write for each register.
+
+A tutorial or guide will be added soon.
+
+## Requirements
+
+* C++20
+* GCC or Clang with some optimization enabled (O1, O2, O3, Os).
-Functional memory-mapped register I/O using modern C++. \ No newline at end of file