Added a README to point users to the documentation on the design of this

library which is a prerequisite for maintaining the library.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@14909 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/include/llvm/System/README.txt b/include/llvm/System/README.txt
new file mode 100644 (file)
index 0000000..1c4860e
--- /dev/null
+++ b/include/llvm/System/README.txt
@@ -0,0 +1,14 @@
+System Utilities Interface
+==========================
+
+The design of this library has several key constraints aimed at shielding LLVM
+from the vagaries of operating system differences. The goal here is to provide
+interfaces to operating system concepts (files, memory maps, sockets, signals,
+locking, etc) efficiently and in such a way that the remainder of LLVM is
+completely operating system agnostic. 
+
+PLEASE READ AND COMPREHEND FULLY THE DOCUMENTATION in 
+
+llvm/docs/SystemLibrary.html 
+
+before making changes to this library.