README.google
README.md
1SwiftShader
2==========
3
4Introduction
5-----------------
6
7SwiftShader 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.
8
9Usage
10--------
11
12The SwiftShader libraries act as drop-in replacements for graphics drivers.
13
14On 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.
15
16Contributing
17-----------------
18
19See CONTRIBUTING.txt for important contributing requirements.
20
21The canonical repository for SwiftShader is hosted at
22https://swiftshader.googlesource.com/SwiftShader
23
24All changes must be reviewed and approved in the Gerrit review tool at
25https://swiftshader-review.googlesource.com
26
27All 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:
28https://gerrit-review.googlesource.com/tools/hooks/commit-msg. To clone the repository and install the commit hook in one go:
29
30 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)
31
32Changes are uploaded to Gerrit by performing
33
34 git push origin HEAD:refs/for/master
35
36Contact
37-----------
38
39Public mailing list: swiftshader@googlegroups.com
40
41License
42----------
43
44The SwiftShader project is licensed under the Apache License Version 2.0. You can find a copy of it in LICENSE.txt.
45
46Files in the third_party folder are subject to their respective license.
47
48Authors and Contributors
49-----------------------------------
50
51The legal authors for copyright purposes are listed in AUTHORS.txt.
52
53CONTRIBUTORS.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.
54
55Disclaimer
56---------------
57
581. Trademarks are the property of their respective owners.
592. We do not claim official conformance with any graphics APIs at this moment.
603. This is not an official Google product.
README.version