summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff Moyer <jmoyer@redhat.com>2018-10-22 14:23:30 -0400
committerJeff Moyer <jmoyer@redhat.com>2018-10-22 14:23:30 -0400
commitd35f3c3cd77ba59ee64cb7a5cc4650258cf2e05c (patch)
treec5a22e3557c9eb05c63c5de21b7373db58131a8a
parent603cab72cb680b252281b1ab3e361a18fab5aee7 (diff)
downloadlibaio-d35f3c3cd77ba59ee64cb7a5cc4650258cf2e05c.tar.gz
Add README.md
The main reason is to document that submitting patches to the mailing list is the preferred method for contributing code. Signed-off-by: Jeff Moyer <jmoyer@redhat.com>
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..692f4a7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# libaio
+
+The Linux-native asynchronous I/O facility ("async I/O", or "aio") has a
+richer API and capability set than the simple POSIX async I/O facility.
+This library, libaio, provides the Linux-native API for async I/O.
+The POSIX async I/O facility requires this library in order to provide
+kernel-accelerated async I/O capabilities, as do applications which
+require the Linux-native async I/O API.
+
+## Contributing
+
+Patches should be submitted to linux-aio@kvack.org.