Add readme file.

Change-Id: I3aaf4819fa629282ebeb9f7e70fbae53c261c25d
Reviewed-on: https://swiftshader-review.googlesource.com/5355
Reviewed-by: Nicolas Capens <capn@google.com>
Tested-by: Nicolas Capens <capn@google.com>

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..71c4b4e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,60 @@
+SwiftShader\r
+==========\r
+\r
+Introduction\r
+-----------------\r
+\r
+SwiftShader is a high-performance CPU-based implementation of the OpenGL ES and Direct3D 9 graphics APIs<sup>1</sup><sup>2</sup>. Its goal is to provide hardware independence for advanced 3D graphics.\r
+\r
+Usage\r
+--------\r
+\r
+The SwiftShader libraries act as drop-in replacements for graphics drivers.\r
+\r
+On Windows, most applications can be made to use SwiftShader's DLLs by placing them in the same folder as the executable. On Linux, the LD\_LIBRARY\_PATH environment variable or -rpath linker option can be used to direct applications to search for shared libraries in the indicated directory first.\r
+\r
+Contributing\r
+-----------------\r
+\r
+See CONTRIBUTING.txt for important contributing requirements.\r
+\r
+The canonical repository for SwiftShader is hosted at\r
+https://swiftshader.googlesource.com/SwiftShader\r
+\r
+All changes must be reviewed and approved in the Gerrit review tool at\r
+https://swiftshader-review.googlesource.com\r
+\r
+All changes require a Change-ID tag in the commit message. A commit hook may be used to add this tag automatically, and can be found at:\r
+https://gerrit-review.googlesource.com/tools/hooks/commit-msg. To clone the repository and install the commit hook in one go: \r
+\r
+    git clone https://swiftshader.googlesource.com/SwiftShader && (cd SwiftShader && curl -Lo `git rev-parse --git-dir`/hooks/commit-msg https://gerrit-review.googlesource.com/tools/hooks/commit-msg ; chmod +x `git rev-parse --git-dir`/hooks/commit-msg)\r
+\r
+Changes are uploaded to Gerrit by performing\r
+\r
+    git push origin HEAD:refs/for/master\r
+\r
+Contact\r
+-----------\r
+\r
+Public mailing list: swiftshader@googlegroups.com\r
+\r
+License\r
+----------\r
+\r
+The SwiftShader project is licensed under the Apache License Version 2.0. You can find a copy of it in LICENSE.txt.\r
+\r
+Files in the third_party folder are subject to their respective license.\r
+\r
+Authors and Contributors\r
+-----------------------------------\r
+\r
+The legal authors for copyright purposes are listed in AUTHORS.txt.\r
+\r
+CONTRIBUTORS.txt contains a list of names of individuals who have contributed to SwiftShader. If you're not on the list, but you've signed the Google CLA and have contributed more than a formatting change, feel free to request to be added.\r
+\r
+Disclaimer\r
+---------------\r
+\r
+1. Trademarks are the property of their respective owners.\r
+2. We do not claim official conformance with any graphics APIs at this moment.\r
+3. This is not an official Google product.
\ No newline at end of file