Skip to content

Commit 86264b0

Browse files
committed
Added Documentation Regarding Release .zips
- Closes #3 - Improved issue template.
1 parent 8db3af2 commit 86264b0

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

ISSUE_TEMPLATE.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
OS:
44

5+
Add-on Version:
6+
7+
Blender Version:
8+
59
VS Code Version:
610

711
VS Code Python Extension Version:
@@ -18,4 +22,4 @@ Python path/interpreter detected/selected by VS Code / Visual Studio: <!-- See C
1822

1923
## Notes:
2024

21-
<!-- Describe your problem, including any specific errors. -->
25+
<!-- Describe your problem and the steps to reproduce it, including any specific errors. -->

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ I have made a video (click the image below) for those who just started messing w
2323
</a>
2424
</p>
2525

26+
## Note on Downloading
27+
28+
The best way to download is through the green `Clone or Download` button above.
29+
30+
If you download the add-on from the releases page, please make sure to rename the zip to `blender-debugger-for-vscode-master.zip`, otherwise the full stops / periods in the version number will cause the add-on to silently fail installing.
2631

2732
## Installing Python and Getting PTVSD
2833

@@ -107,10 +112,12 @@ Now in Blender the text editor will show this little red button in the top left.
107112
# Troubleshooting
108113

109114
- Check you installed the correct ptvsd version.
110-
- To determine whether the problem is on Blender's side or your editor's: Close Blender and download/copy this [test script](https://gist.github.com/AlansCodeLog/ff1b246a8e31938e1c3dbfdcbb90522f) and run it with Python then and try to connect to the server with your editor. If you're still getting problem's than the problem is with VS Code.
111-
- Check your detected your Python install, or set it manually.
112-
- For VS Code try reinstalling the VS Code Python extension.
113-
115+
- To determine whether the problem is on Blender's side or your editor's: Close Blender and download/copy this [test script](https://gist.github.com/AlansCodeLog/ff1b246a8e31938e1c3dbfdcbb90522f) and run it with Python, and then try to connect to the server with your editor. If you're still getting problems then the problem is with VS Code, try:
116+
- Check your detected your Python install, or set it manually.
117+
- For VS Code try reinstalling the VS Code Python extension.
118+
119+
Otherwise, if nothing works, don't hesitate to file an issue.
120+
114121
# Notes
115122

116123
<a id="f1" href="#n1">1.</a> Technically, the add-on will work with Python 2 as well since it doesn't use Python itself, just the ptvsd package, so it doesn't really matter whether you installed it with Python 2 or 3 because the package is compatible with both. On the VS Code side though, the Python extension does need to know where Python is (though not ptvsd), but it still will connect if it's using Python 2, just IntelliSense recommendations the will be wrong.

0 commit comments

Comments
 (0)