diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0811d6e5a..24ff04c4b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ Want to contribute? Great! First, read this page (including the small print at -the end). Then, have a look at DEVELOPMENT.howto.md, which contains useful info -to guide you along the way. +the end). Then, have a look at [`DEVELOPMENT.howto.md`](DEVELOPMENT.howto.md), +which contains useful info to guide you along the way. ## Before you contribute diff --git a/DEVELOPMENT.howto.md b/DEVELOPMENT.howto.md index 4ccd2e0e8..df542fca4 100644 --- a/DEVELOPMENT.howto.md +++ b/DEVELOPMENT.howto.md @@ -1,11 +1,11 @@ Thank you for considering Shaderc development! Please make sure you review -CONTRIBUTING.md for important preliminary info. +[`CONTRIBUTING.md`](CONTRIBUTING.md) for important preliminary info. ## Building -Instructions for first-time building can be found in README.md. Incremental -build after a source change can be done using `ninja` (or `cmake --build`) and -`ctest` exactly as in the first-time procedure. +Instructions for first-time building can be found in [`README.md`](README.md). +Incremental build after a source change can be done using `ninja` (or +`cmake --build`) and `ctest` exactly as in the first-time procedure. ## Code reviews @@ -62,13 +62,13 @@ master. Changes made to glslang in the course of Shaderc development must build and test correctly on their own, independently of Shaderc code, so they don't break other users of glslang when sent upstream. We will periodically upstream the content -of our fork's master to the official glslang master, so all the contributions we -accept will find their way to glslang. +of our fork's `master` branch to the official glslang `master` branch, so all +the contributions we accept will find their way to glslang. We aim to keep our fork up to date with the official glslang by pulling their -changes frequently and merging them into our master. +changes frequently and merging them into our `master` branch.
\*: with one small exception: if a Shaderc and glslang pull requests -need each other and are simultaneously cherry-picked, then a HEADs inconsistency -will be tolerated for the short moment that one has landed while the other -hasn't. +need each other and are simultaneously cherry-picked, then a `HEAD`s +inconsistency will be tolerated for the short moment that one has landed while +the other hasn't. diff --git a/README.md b/README.md index 3ae9d1bb8..c544b1867 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,14 @@ A collection of tools, libraries and tests for shader compilation. Shaderc is experimental, and subject to significant incompatible changes. -For licensing terms, please see the `LICENSE` file. If interested in -contributing to this project, please see `CONTRIBUTING.md`. +For licensing terms, please see the [`LICENSE`](LICENSE) file. If interested in +contributing to this project, please see [`CONTRIBUTING.md`](CONTRIBUTING.md) This is not an official Google product (experimental or otherwise), it is just code that happens to be owned by Google. That may change if Shaderc gains -contributions from others. See the `CONTRIBUTING.md` file for more information. -See also the `AUTHORS` and `CONTRIBUTORS` files. +contributions from others. See the [`CONTRIBUTING.md`](CONTRIBUTING.md) file +for more information. See also the [`AUTHORS`](AUTHORS) and +[`CONTRIBUTORS`](CONTRIBUTORS) files. ## File organization