You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-11Lines changed: 10 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -8,17 +8,19 @@ RenderDoc
8
8
9
9
Welcome to RenderDoc - a graphics debugger, currently available for D3D11, Vulkan and OpenGL development on windows.
10
10
11
+
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:[email protected]) or [come into IRC](https://kiwiirc.com/client/irc.freenode.net/#renderdoc) to discuss it.
12
+
11
13
Quick Links:
12
14
13
15
***Downloads**: https://renderdoc.org/builds
14
-
***Documentation**: renderdoc.chm in the build, or https://renderdoc.org/docs
15
-
***Tutorials**: There are some video tutorials on Youtube: http://www.youtube.com/user/baldurkarlsson/
16
+
***Documentation**: [renderdoc.chm](https://renderdoc.org/docs/renderdoc.chm) in builds, or https://renderdoc.org/docs
***Starting place for developing/contributing**: [CONTRIBUTING.md](CONTRIBUTING.md)
20
-
***Code of Conduct**: [contributor covenent](CODE_OF_CONDUCT.md)
21
-
***How to compile**: [compilation instructions](CONTRIBUTING.md#compiling)
22
+
***How to compile**: [Compilation instructions](CONTRIBUTING.md#compiling)
23
+
***Code of Conduct**: [Contributor Covenent](CODE_OF_CONDUCT.md)
22
24
23
25
Screenshots
24
26
--------------
@@ -44,7 +46,7 @@ API Support
44
46
45
47
* 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.
46
48
*\*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.
47
-
*\*\*A Qt version of the UI is planned, with some [implementation notes on the wiki](https://github.com/baldurk/renderdoc/wiki/QRenderDoc-Notes).
49
+
*\*\*A Qt UI [is in progress](qrenderdoc), with some [implementation notes on the wiki](https://github.com/baldurk/renderdoc/wiki/QRenderDoc-Notes).
48
50
49
51
Downloads
50
52
--------------
@@ -56,7 +58,7 @@ It's recommended that if you're new you start with the stable builds. Nightly bu
56
58
Documentation
57
59
--------------
58
60
59
-
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).
61
+
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).
60
62
61
63
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.
62
64
@@ -67,13 +69,10 @@ License
67
69
68
70
RenderDoc is released under the MIT license, see [LICENSE.md](LICENSE.md) for full text as well as 3rd party library acknowledgements.
69
71
70
-
Building
72
+
Contributing & Development
71
73
--------------
72
74
73
75
Building RenderDoc is fairly straight forward. See [CONTRIBUTING.md](CONTRIBUTING.md#compiling) for more details.
74
76
75
-
Contributing & Development
76
-
--------------
77
-
78
-
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.
77
+
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 commit comments