aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c014ec2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,6 @@
+# `cerm` — C Inspired Error Reporting Macros
+
+This crate provides a few handy macros in the style of BSD C’s `<err.h>` for
+error-reporting to the user. These macros just remove some of the boilerplate of
+having to prefix your diagnostic messages with `progname: ` everytime you want to
+exit the program.