Prettify documentation. Change-Id: Ief18bd1e251f84128660fd559d997e0d094c7abf Reviewed-on: https://swiftshader-review.googlesource.com/10348 Reviewed-by: Nicolas Capens <capn@google.com> Tested-by: Nicolas Capens <capn@google.com>
diff --git a/README.md b/README.md index 6166bf2..ac2edf2 100644 --- a/README.md +++ b/README.md
@@ -1,14 +1,14 @@ -SwiftShader [](https://travis-ci.org/google/swiftshader) [](https://ci.appveyor.com/project/c0d1f1ed/swiftshader) +# SwiftShader [](https://travis-ci.org/google/swiftshader) [](https://ci.appveyor.com/project/c0d1f1ed/swiftshader) -========== +----------------------------------------------------------------------------------------------------------- Introduction ------------------ +------------ 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. Usage --------- +----- The SwiftShader libraries act as drop-in replacements for graphics drivers. @@ -17,7 +17,7 @@ Prebuilt binaries can be found at: https://goo.gl/5MOcdb Contributing ------------------ +------------ See [CONTRIBUTING.txt](CONTRIBUTING.txt) for important contributing requirements. @@ -60,28 +60,28 @@ See [docs/Index.md](docs/Index.md). Contact ------------ +------- Public mailing list: [swiftshader@googlegroups.com](https://groups.google.com/forum/#!forum/swiftshader) Bug tracker: https://bugs.chromium.org/p/swiftshader License ----------- +------- 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. Authors and Contributors ------------------------------------ +------------------------ The legal authors for copyright purposes are listed in [AUTHORS.txt](AUTHORS.txt). [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 ---------------- +---------- 1. Trademarks are the property of their respective owners. 2. We do not claim official conformance with any graphics APIs at this moment.
diff --git a/docs/Subzero.md b/docs/Subzero.md index ae5c046..c66c15a 100644 --- a/docs/Subzero.md +++ b/docs/Subzero.md
@@ -14,6 +14,6 @@ Development on Subzero itself requires setting up the NaCl environment on a Linux system to be able to run its unit tests: * Install Chrome's [depot_tools](http://dev.chromium.org/developers/how-tos/install-depot-tools). -* Run ```mkdir nacl && cd nacl && fetch nacl``` ([ref](http://www.chromium.org/nativeclient/how-tos/how-to-use-git-svn-with-native-client)). -* Run ```native_client/toolchain_build/toolchain_build_pnacl.py --verbose --sync --clobber --install toolchain/linux_x86/pnacl_newlib_raw``` ([ref](https://sites.google.com/a/chromium.org/dev/nativeclient/pnacl/developing-pnacl#TOC-TL-DR-for-checking-out-PNaCl-sources-building-and-testing)). -* Run all unit tests with ```make -f Makefile.standalone check``` ([ref](https://chromium.googlesource.com/native_client/pnacl-subzero/+/master/docs/README.rst)). +* Run `mkdir nacl && cd nacl && fetch nacl` ([ref](http://www.chromium.org/nativeclient/how-tos/how-to-use-git-svn-with-native-client)). +* Run `native_client/toolchain_build/toolchain_build_pnacl.py --verbose --sync --clobber --install toolchain/linux_x86/pnacl_newlib_raw` ([ref](https://sites.google.com/a/chromium.org/dev/nativeclient/pnacl/developing-pnacl#TOC-TL-DR-for-checking-out-PNaCl-sources-building-and-testing)). +* Run all unit tests with `make -f Makefile.standalone check` ([ref](https://chromium.googlesource.com/native_client/pnacl-subzero/+/master/docs/README.rst)).