Add basic README

[mirror_spl.git] / README.markdown

diff --git a/README.markdown b/README.markdown
new file mode 100644 (file)
index 0000000..6189ad6
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,10 @@
+The Solaris Porting Layer (SPL) is a Linux kernel module which provides
+many of the Solaris kernel APIs.  This shim layer makes it possible to
+run Solaris kernel code in the Linux kernel with relatively minimal
+modification.  This can be particularly useful when you want to track
+upstream Solaris development closely and don’t want the overhead of
+maintaining a large patch which converts Solaris primitives to Linux
+primitives.
+
+Documentation for building, configuring, and using the SPL can be
+found at: <http://wiki.github.com/behlendorf/spl/>