lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-05-05 17:40:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add note of rules to bug report template and README

Browse Source
This commit is contained in:
baldurk
2023-04-06 16:39:22 +01:00
parent 04a0fdb538
commit 8009df5027
2 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/ISSUE_TEMPLATE/bug_report.md
+5 -1
View File
@@ -4,12 +4,16 @@ about: Report a bug or problem encountered while using RenderDoc
---
<!--
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
IF YOU DO NOT FOLLOW THE GUIDELINES, OR DO NOT USE THE TEMPLATE BELOW, YOUR ISSUE WILL BE CLOSED! NO EXCEPTIONS!
If you do not follow the guidelines, or do not use the template below, your issue will be closed with no exceptions!
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
The template below shows what you need to include in a good bug report, and you MUST use it. More information in the docs:
https://github.com/baldurk/renderdoc/blob/v1.x/docs/CONTRIBUTING/Filing-Issues.md
It is *expressly* forbidden to ask for help with capturing copyrighted programs that you did not create and do not have the source code for.
For example this includes capturing commercial games that you did not create, or capturing Google Maps or Google Earth.
I'm happy to help, but you have to ensure I fully understand what you want and have the information I need. If you're unsure, please read the guide above for full information on what is expected for filing issues.
-->
README.md
+2
View File
@@ -6,6 +6,8 @@
RenderDoc is a frame-capture based graphics debugger, currently available for Vulkan, D3D11, D3D12, OpenGL, and OpenGL ES development on Windows, Linux, Android, and Nintendo Switch&trade;. It is completely open-source under the MIT license.
RenderDoc is intended for debugging your own programs only. Any discussion of capturing programs that you did not create will not be allowed in any official public RenderDoc setting, including the issue tracker, discord, or via email. For example this includes capturing commercial games that you did not create, or capturing Google Maps or Google Earth. Note: Capturing projects you created that use a third party engine like Unreal or Unity, or open source and free projects is completely fine and supported.
If you have any questions, suggestions or problems or you can [create an issue](https://github.com/baldurk/renderdoc/issues/new/choose) here on github, [email me directly](mailto:baldurk@baldurk.org) or come into [IRC](https://webchat.oftc.net/?channels=renderdoc) or [Discord](https://discord.gg/ahq6yRB) to discuss it.
To install on windows run the appropriate installer for your OS ([64-bit](https://renderdoc.org/stable/latest/RenderDoc_latest_64.msi) | [32-bit](https://renderdoc.org/stable/latest/RenderDoc_latest_32.msi)) or download the portable zip from the [builds page](https://renderdoc.org/builds). The 64-bit windows build fully supports capturing from 32-bit programs. On linux only 64-bit x86 is supported - there is a precompiled [binary tarball](https://renderdoc.org/stable/latest/renderdoc_latest.tar.gz) available, or your distribution may package it. If not you can [build from source](docs/CONTRIBUTING/Compiling.md).