Added readme and missing info filesv0.1.0

7 files changed, 100 insertions, 2 deletions

diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..e8d3abd
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1 @@
+Michał Łyszczek <michal.lyszczek@bofc.pl>
diff --git a/COPYING b/COPYING
new file mode 120000
index 0000000..7a694c9
--- /dev/null
+++ b/COPYING
@@ -0,0 +1 @@
+LICENSE
\ No newline at end of file
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..de2835e
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,4 @@
+$ autoreconf -i (if ./configure doesn't exit)
+$ ./configure
+$ make
+# make install
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..211d590
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,22 @@
+Copyright 2017 Michał Łyszczek <michal.lyszczek@bofc.pl>
+
+Redistribution and use in source and binary forms, with or without modification,
+are   permitted   provided   that   the   following    conditions    are    met:
+
+1.  Redistributions of source code must retain the above copyright notice,  this
+list of conditions and the following disclaimer.
+
+2.  Redistributions in binary form must reproduce the  above  copyright  notice,
+this list of conditions and the following disclaimer in the documentation and/or
+other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"  AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED  TO,  THE  IMPLIED
+WARRANTIES  OF  MERCHANTABILITY  AND  FITNESS  FOR  A  PARTICULAR  PURPOSE   ARE
+DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR  CONTRIBUTORS  BE  LIABLE
+FOR ANY DIRECT,  INDIRECT,  INCIDENTAL,  SPECIAL,  EXEMPLARY,  OR  CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED  TO,  PROCUREMENT  OF  SUBSTITUTE  GOODS  OR
+SERVICES; LOSS OF USE, DATA,  OR  PROFITS;  OR  BUSINESS  INTERRUPTION)  HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
+TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF  THE  USE  OF
+THIS  SOFTWARE,  EVEN  IF  ADVISED  OF   THE   POSSIBILITY   OF   SUCH   DAMAGE.
diff --git a/configure.ac b/configure.ac
index 9036b8b..f32f1ae 100644
--- a/configure.ac
+++ b/configure.ac
@@ -1,4 +1,4 @@
-AC_INIT([embedlog], [0.0.1], [michal.lyszczek@bofc.pl])
+AC_INIT([embedlog], [0.1.0], [michal.lyszczek@bofc.pl])
 AM_INIT_AUTOMAKE([foreign subdir-objects])
 AC_LANG([C])
 AC_PROG_CC
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..471c2b0
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,70 @@
+About
+=====
+
+Logger written in C89 targeting embedded systems. It's main goals are to be
+small and fast. Many features can be disabled during compilation to generate
+smaller binary. Ammount of needed stack memory can be lowered by adjusting
+maximum printable size of single log message. Implemented features are:
+
+  * printing to different outputs (simultaneously) like:
+    - standard error (stderr)
+    - file (with optional log rotate)
+    - custom routine - can be anything **embedlog** just calls custom function
+      with string to print
+  * timestamp to every message
+    - clock_t
+    - time_t
+    - CLOCK_REALTIME (requires POSIX)
+    - CLOCK_MONOTONIC (requires POSIX)
+  * print location of printed log (file and line)
+  * 8 predefinied log levels and (sizeof(int) - 8) custom log levels ;-)
+  * colorful output (ansi colors) for easy error spotting
+  * print memory block in wireshark-like output
+
+Almost all of these features can be disabled to save some precious bytes of
+memory.
+
+Dependencies
+============
+
+Library is written in C89 but some features require implemented POSIX to work.
+Also there are some additional features for users with C99 compiler.
+
+To run unit tests, you also need [librb][https://github.com/mlyszczek/librb]
+
+License
+=======
+
+Library is licensed under BSD 2-clause license. See LICENSE file for details
+
+Compiling and installing
+========================
+
+Project uses standard automake so to build you need to:
+
+~~~
+$ autoreconf -i
+$ ./configure
+$ make
+# make install
+~~~
+
+Functions description
+=====================
+
+For detailed description of every function check out man pages.
+
+Contact
+=======
+
+Michał Łyszczek <michal.lyszczek@bofc.pl>
+
+Thanks to
+=========
+
+- Mark Martinec for nice C89 implementation of snprintf and familly
+  (https://www.ijs.si/software/snprintf/)
+- Myself for developing very simple unit test framework
+(https://github.com/mlyszczek/mtest) for easy testing
+- Myself for developing ring buffer used in unit tests
+ (https://github.com/mlyszczek/librb)
diff --git a/src/Makefile.am b/src/Makefile.am
index 97c27a9..9206773 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -18,5 +18,5 @@ if CUSTOM_SNPRINTF
 libembedlog_la_SOURCES += snprintf.c
 endif
 
-libembedlog_la_LDFLAGS = -version-info 0:0:0
+libembedlog_la_LDFLAGS = -version-info 1:0:1
 libembedlog_la_CFLAGS = -I$(top_srcdir)/include