Merge pull request #281 from matthiasbeyer/per-crate-readme

Per crate readme

imag-counter/README.md

@@ -0,0 +1,11 @@
+# imag-counter
+
+A simple module to count things.
+
+```bash
+imag counter create --name example --initval 42 # or: -n example -i 42
+imag counter --inc example # or -i example
+imag counter --reset example
+imag counter --dev example # or -d example
+```
+

imag-link/README.md

@@ -0,0 +1,5 @@
+# imag-link
+
+Utility to link entries. Not meant to be called by normal users but by
+developers to investigate the store.
+

imag-store/README.md

@@ -0,0 +1,4 @@
+# imag-store
+
+Minimal commandline interface for the store. Not meant to be called by users but
+by developers to investigate the store.

imag-tag/README.md

@@ -0,0 +1,4 @@
+# imag-tag
+
+Commandline frontend for the tagging library. Not meant to be called by the user
+but by developers to investigate tags of entries.

imag-view/README.md

@@ -0,0 +1,4 @@
+# imag-view
+
+Simple commandline utility to print entries to the commandline output.
+

libimagcounter/README.md

@@ -0,0 +1,4 @@
+# libimagcounter
+
+Library of "imag-counter", usable by other modules as well to implement counter
+functionality for entries.

libimagentryfilter/README.md

@@ -0,0 +1,9 @@
+# libimagentryfilter
+
+Helper library to filter lists of entries by certain predicated. Offers filters
+for filtering by header values and other predicates, plus this library offers
+logical operants to combine filters.
+
+A commandline-to-filter DSL is planned for this, so commandline applications can
+use this to implement a uniform filter interface.
+

libimaglink/README.md

@@ -0,0 +1,5 @@
+# libimaglink
+
+Linking library for linking entries with other entries. Used for "imag-link",
+the commandline utility, but intended for use in other binaries and libraries as
+well.

libimagrt/README.md

@@ -4,3 +4,8 @@ This library provides utility functionality for the modules and the binary
 frontends, such as reading and parsing the configuration file, a builder
 helper for the commandline interface and such.
 
+It also contains the store object and creates it from configuration.
+
+the `libimagrt::runtime::Runtime` object is the first complex object that comes
+to live in a imag binary.
+

libimagstore/README.md

@@ -0,0 +1,11 @@
+# libimagstore
+
+The store is the heart of everything. Here lives the data, the complexity and
+the performance bottleneck.
+
+The store offeres read/write access to all entries, a hook system to do
+on-the-fly modification of incoming/outgoing files and so on.
+
+The store itself does not offer functionality, but has a commandline interface
+"imag-store" which can do basic things with the store.
+

libimagtag/README.md

@@ -0,0 +1,6 @@
+# libimagtag
+
+Library for tagging entries. Used in "imag-tag" but should be used in all other
+modules which contain tagging functionality, so the backend and frontend look
+the same for all modules.
+

libimagutil/README.md

@@ -0,0 +1,4 @@
+# libimagutil
+
+Utility library. Does not depend on other imag crates.
+