Commit cf83d168 by Nicolas Capens

Improve documentation.

Change-Id: Iab20bde3fdf1fee5c6b47c748baae0266769e333 Reviewed-on: https://swiftshader-review.googlesource.com/5782Reviewed-by: 's avatarNicolas Capens <capn@google.com> Tested-by: 's avatarNicolas Capens <capn@google.com>
parent 7e9ba096
...@@ -19,6 +19,8 @@ frustration later on. ...@@ -19,6 +19,8 @@ frustration later on.
### Code reviews ### Code reviews
All submissions, including submissions by project members, require review. All submissions, including submissions by project members, require review.
Information on how to sumbit changes for review is provided in README.md.
### The small print ### The small print
Contributions made by corporations are covered by a different agreement than Contributions made by corporations are covered by a different agreement than
the one above, the the one above, the
......
...@@ -16,20 +16,23 @@ On Windows, most applications can be made to use SwiftShader's DLLs by placing t ...@@ -16,20 +16,23 @@ On Windows, most applications can be made to use SwiftShader's DLLs by placing t
Contributing Contributing
----------------- -----------------
See CONTRIBUTING.txt for important contributing requirements. See [CONTRIBUTING.txt](CONTRIBUTING.txt) for important contributing requirements.
The canonical repository for SwiftShader is hosted at The canonical repository for SwiftShader is hosted at:
https://swiftshader.googlesource.com/SwiftShader https://swiftshader.googlesource.com/SwiftShader
All changes must be reviewed and approved in the Gerrit review tool at All changes must be reviewed and approved in the [Gerrit](https://www.gerritcodereview.com/) review tool at:
https://swiftshader-review.googlesource.com https://swiftshader-review.googlesource.com
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: Authenticate your account here:
https://swiftshader-review.googlesource.com/new-password
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:
https://gerrit-review.googlesource.com/tools/hooks/commit-msg. To clone the repository and install the commit hook in one go: https://gerrit-review.googlesource.com/tools/hooks/commit-msg. To clone the repository and install the commit hook in one go:
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) 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)
Changes are uploaded to Gerrit by performing Changes are uploaded to Gerrit by performing:
git push origin HEAD:refs/for/master git push origin HEAD:refs/for/master
...@@ -43,21 +46,21 @@ Contact ...@@ -43,21 +46,21 @@ Contact
Public mailing list: swiftshader@googlegroups.com Public mailing list: swiftshader@googlegroups.com
Bug tracker: bugs.chromium.org/p/swiftshader Bug tracker: https://bugs.chromium.org/p/swiftshader
License License
---------- ----------
The SwiftShader project is licensed under the Apache License Version 2.0. You can find a copy of it in LICENSE.txt. The SwiftShader project is licensed under the Apache License Version 2.0. You can find a copy of it in [LICENSE.txt](LICENSE.txt).
Files in the third_party folder are subject to their respective license. Files in the third_party folder are subject to their respective license.
Authors and Contributors Authors and Contributors
----------------------------------- -----------------------------------
The legal authors for copyright purposes are listed in AUTHORS.txt. The legal authors for copyright purposes are listed in [AUTHORS.txt](AUTHORS.txt).
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. [CONTRIBUTORS.txt](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](https://cla.developers.google.com/clas) and have contributed more than a formatting change, feel free to request to be added.
Disclaimer Disclaimer
--------------- ---------------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment