From eafd8c1ae593dba31f5bfbd6618b89918f6f68a4 Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Wed, 24 Aug 2016 13:49:53 +0200 Subject: [PATCH] Add README.md for libimagerror --- libimagerror/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 libimagerror/README.md diff --git a/libimagerror/README.md b/libimagerror/README.md new file mode 100644 index 00000000..f61724cf --- /dev/null +++ b/libimagerror/README.md @@ -0,0 +1,21 @@ +# libimagerror + +In imag, we do not panic. + +Whatever we do, if we fail as hard as possible, the end-user should _never ever_ +see a backtrace from a `panic!()`. + +Anyways, the user _might_ see a error trace generated by imag. +That is because imag is software for power-users, for nerds (I use the term +"nerd" because for me it is a good thing - I do not want to offend anyone by +using it). +This target group can read backtraces without getting confused. `IO Error` and +`Permission denied Error` are things that nerds can understand and they already +know what to do in the most obvious cases (such as `Permission denied Error`). + +This library crate is for generating error types and handle them in a nice way. +It can be seen as mini-framework inside imag which was written to work with +error types in a specified way. All imag crates _must_ use this library if they +can return errors in any way, except the `libimagutil` - which is for the most +basic utilities. +