aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md
index 11b0f65..01be4d4 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,16 @@
printf
======
-Tiny but fully loaded printf implementation
+This is a very tiny but fully loaded printf, sprintf and snprintf implementation.
+Designed for usage in embedded systems, where printf is not available due to memory issues or avoidance of linking against libc.
+
+All type and format specifiers are supported.
+
+This is written in C++ and uses a templated itoa. But you can easily port it to plain C if you can't use C++.
+
+
+Design goals:
+
+ - No dependencies
+ - LINT and compiler L4 warning free, clean code
+ - MIT license