Implement an Android NDK build of SwiftShader using the CMake files.

[android-x86/external-swiftshader.git] / README.md

diff --git a/README.md b/README.md
index ac2edf2..8cfa348 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,33 @@
-# SwiftShader [![Build Status](https://travis-ci.org/google/swiftshader.svg?branch=master)](https://travis-ci.org/google/swiftshader) [![Build status](https://ci.appveyor.com/api/projects/status/yrmyvb34j22jg1uj?svg=true)](https://ci.appveyor.com/project/c0d1f1ed/swiftshader)\r
+# SwiftShader\r
 \r
------------------------------------------------------------------------------------------------------------\r
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Build Status](https://travis-ci.org/google/swiftshader.svg?branch=master)](https://travis-ci.org/google/swiftshader) [![Build status](https://ci.appveyor.com/api/projects/status/yrmyvb34j22jg1uj?svg=true)](https://ci.appveyor.com/project/c0d1f1ed/swiftshader)\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
+Building\r
+--------\r
+\r
+SwiftShader libraries can be built for Windows, Linux, and Mac OS X.\\r
+Android and Chrome (OS) build environments are also supported.\r
+\r
+* **Visual Studio**\r
+\\r
+  On Windows, open the [SwiftShader.sln](SwiftShader.sln) file using [Visual Studio Community](https://visualstudio.microsoft.com/vs/community/) or compatible version, and build the solution. Output DLLs will be placed in the _out_ subfolder. Sample executables such as _OGLES3ColourGrading_ can be found under the Tests solution folder and can be run from the IDE.\r
+\r
+* **CMake**\r
+\r
+  [Install CMake](https://cmake.org/download/) for Linux, Mac OS X, or Windows and use either [the IDE](https://cmake.org/runningcmake/) or run the following terminal commands:\r
+\r
+      cd build\r
+      cmake ..\r
+      make --jobs=8\r
+\r
+      ./unittests\r
+      ./OGLES2HelloAPI\r
+\r
 Usage\r
 -----\r
 \r
@@ -14,8 +35,6 @@ The SwiftShader libraries act as drop-in replacements for graphics drivers.
 \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
-Prebuilt binaries can be found at: https://goo.gl/5MOcdb\r
-\r
 Contributing\r
 ------------\r
 \r
@@ -31,14 +50,21 @@ Authenticate your account here:
 https://swiftshader-review.googlesource.com/new-password\r
 \r
 All changes require a [Change-ID](https://gerrit-review.googlesource.com/Documentation/user-changeid.html) 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
+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
+Changes are uploaded to Gerrit by executing:\r
 \r
     git push origin HEAD:refs/for/master\r
 \r
+Testing\r
+-------\r
+\r
+SwiftShader's OpenGL ES implementation can be tested using the [dEQP](https://source.android.com/devices/graphics/testing) test suite.\r
+\r
+See [docs/dEQP.md](docs/dEQP.md) for details.\r
+\r
 Third-Party Dependencies\r
 ------------------------\r
 \r
@@ -64,7 +90,8 @@ Contact
 \r
 Public mailing list: [swiftshader@googlegroups.com](https://groups.google.com/forum/#!forum/swiftshader)\r
 \r
-Bug tracker: https://bugs.chromium.org/p/swiftshader\r
+General bug tracker:  https://g.co/swiftshaderbugs\\r
+Chrome specific bugs: https://bugs.chromium.org/p/swiftshader\r
 \r
 License\r
 -------\r