osprepare: add a simple README.md

Github readers see the README.md. There's more detailed information and the automatically generated API info in godoc, so mostly just refer there. Signed-off-by: Tim Pepper <[email protected]>
ciao-project · Aug 26, 2016 · 06b4c13 · 06b4c13
1 parent d55e10b
commit 06b4c13
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/osprepare/README.md b/osprepare/README.md
@@ -0,0 +1,15 @@
+# osprepare
+
+osprepare is the Operating System Preparation facility of Ciao, enabling
+very simple automated configuration of dependencies between various
+Linux distributions in a sane fashion.
+
+It provides a simple mechanism for expressing system dependencies and then
+handles the OS-specific plumbing transparently.  In this way a ciao
+component can in one place articulate its dependencies and with a single
+call out get runtime confirmation that the system has the needed code,
+without having to care about the details of whether that happens via a call
+to apt or rpm or any other package/update manager software.
+
+For more detailed technical information see the [osprepare package godoc
+page](https://godoc.org/github.com/01org/ciao/osprepare).