Skip to content

Commit

Permalink
Minor tweaks to README phrasing/organisation/links.
Browse files Browse the repository at this point in the history
  • Loading branch information
baldurk committed Sep 27, 2016
1 parent 24c28ec commit 1a46510
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,19 @@ RenderDoc

Welcome to RenderDoc - a graphics debugger, currently available for D3D11, Vulkan and OpenGL development on windows.

If you have any questions, suggetions or problems or you can [create an issue](https://github.com/baldurk/renderdoc/issues/new) here on github, [email me directly](mailto:baldurk@baldurk.org) or [come into IRC](https://kiwiirc.com/client/irc.freenode.net/#renderdoc) to discuss it.

Quick Links:

* **Downloads**: https://renderdoc.org/builds
* **Documentation**: renderdoc.chm in the build, or https://renderdoc.org/docs
* **Tutorials**: There are some video tutorials on Youtube: http://www.youtube.com/user/baldurkarlsson/
* **Documentation**: [renderdoc.chm](https://renderdoc.org/docs/renderdoc.chm) in builds, or https://renderdoc.org/docs
* **Tutorial Videos**: http://www.youtube.com/user/baldurkarlsson/
* **Email contact**: [baldurk@baldurk.org](mailto:baldurk@baldurk.org)
* **IRC channel**: [#renderdoc on freenode](https://kiwiirc.com/client/irc.freenode.net/#renderdoc)
* **Roadmap/future development**: [Roadmap](https://github.com/baldurk/renderdoc/wiki/Roadmap)
* **Starting place for developing/contributing**: [CONTRIBUTING.md](CONTRIBUTING.md)
* **Code of Conduct**: [contributor covenent](CODE_OF_CONDUCT.md)
* **How to compile**: [compilation instructions](CONTRIBUTING.md#compiling)
* **How to compile**: [Compilation instructions](CONTRIBUTING.md#compiling)
* **Code of Conduct**: [Contributor Covenent](CODE_OF_CONDUCT.md)

Screenshots
--------------
Expand All @@ -44,7 +46,7 @@ API Support

* D3D11 has full feature support and is stable & tested. Feature Level 11 hardware is assumed - Radeon 4000/5000+, GeForce 400+, Intel Ivy Bridge, falling back to WARP software emulation if this hardware isn't present.
* \*OpenGL is only explicitly supported for the core profile 3.2+ subset of features, check the [OpenGL wiki page](https://github.com/baldurk/renderdoc/wiki/OpenGL) for details.
* \*\*A Qt version of the UI is planned, with some [implementation notes on the wiki](https://github.com/baldurk/renderdoc/wiki/QRenderDoc-Notes).
* \*\*A Qt UI [is in progress](qrenderdoc), with some [implementation notes on the wiki](https://github.com/baldurk/renderdoc/wiki/QRenderDoc-Notes).

Downloads
--------------
Expand All @@ -56,7 +58,7 @@ It's recommended that if you're new you start with the stable builds. Nightly bu
Documentation
--------------

The text documentation is available [online for the latest stable version](https://renderdoc.org/docs/), as well as in renderdoc.chm in any build. It's built from [restructured text with sphinx](docs).
The text documentation is available [online for the latest stable version](https://renderdoc.org/docs/), as well as in [renderdoc.chm](https://renderdoc.org/docs/renderdoc.chm) in any build. It's built from [restructured text with sphinx](docs).

As mentioned above there are some [youtube videos](http://www.youtube.com/user/baldurkarlsson/) showing the use of some basic features and an introduction/overview.

Expand All @@ -67,13 +69,10 @@ License

RenderDoc is released under the MIT license, see [LICENSE.md](LICENSE.md) for full text as well as 3rd party library acknowledgements.

Building
Contributing & Development
--------------

Building RenderDoc is fairly straight forward. See [CONTRIBUTING.md](CONTRIBUTING.md#compiling) for more details.

Contributing & Development
--------------

I've added some notes on how to contribute, as well as where to get started looking through the code in [CONTRIBUTING.md](CONTRIBUTING.md) - as well as details on how to set up to build renderdoc.
I've added some notes on how to contribute, as well as where to get started looking through the code in [CONTRIBUTING.md](CONTRIBUTING.md).

0 comments on commit 1a46510

Please sign in to comment.