Skip to content

Commit

Permalink
Use monospace font and add links where appropriate.
Browse files Browse the repository at this point in the history
  • Loading branch information
antiagainst committed Aug 14, 2015
1 parent 764b2b7 commit edb6d44
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 16 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
20 changes: 10 additions & 10 deletions DEVELOPMENT.howto.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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.

<hr><small>\*: 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.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit edb6d44

Please sign in to comment.