Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit c25b99c

Browse files
committed
Updated with details on configuration and the like
1 parent 351a6e5 commit c25b99c

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
# Python
22
Linting, Debugging (multi-threaded, web apps, remote), Intellisense, auto-completion, code formatting, snippets, unit testing, and more.
33

4-
##[Wiki](https://github.com/DonJayamanne/pythonVSCode/wiki)
5-
Once installed, do remember to [configure the path](https://github.com/DonJayamanne/pythonVSCode/wiki/Python-Path-and-Version) to the python executable.
4+
##[Documentation](https://github.com/DonJayamanne/pythonVSCode/wiki)
5+
###Getting Started
6+
* Install the extension
7+
* If not using [Virtual Environments](https://virtualenv.readthedocs.org/) and the Python executable isn't located in the current path, then [configure the path](https://github.com/DonJayamanne/pythonVSCode/wiki/Python-Path-and-Version) to the python executable.
8+
* If using [Virtual Environments](https://virtualenv.readthedocs.org/), you could either:
9+
+ Activate the virtual environment from within your terminal/command window and then launch VS Code (see [wiki](https://github.com/DonJayamanne/pythonVSCode/wiki/Python-Path-and-Version#virtual-environments)).
10+
+ Or manually [configure the paths](https://github.com/DonJayamanne/pythonVSCode/wiki/Python-Path-and-Version).
611

7-
If you're working in a [virtualenv](https://virtualenv.readthedocs.org/), you can reference the `python` interpreter from your virtualenv (ie `~/.virtualenvs/XXX/bin/python`).
12+
###[Troubleshooting guide](https://github.com/DonJayamanne/pythonVSCode/wiki/Troubleshooting)
813

914
##Features
1015
* Linting (Prospector, PyLint, Pep8, Flake8, pydocstyle with config files and plugins)
@@ -24,6 +29,11 @@ If you're working in a [virtualenv](https://virtualenv.readthedocs.org/), you ca
2429

2530
##[Issues and Feature Requests](https://github.com/DonJayamanne/pythonVSCode/issues)
2631

32+
## Contributing
33+
* Clone the repository and open in VS Code.
34+
* Ensure you have NodeJS installed and all of the dependendant node modules are installed (use 'npm install' command).
35+
* You can debug the extension by using the 'Launch Extension' debug configuration.
36+
2737
## Feature Details (with configuration)
2838
* IDE Features
2939
+ Auto indenting
@@ -222,11 +232,6 @@ If you're working in a [virtualenv](https://virtualenv.readthedocs.org/), you ca
222232
### Version 0.0.3
223233
* Added support for debugging using PDB
224234

225-
226-
## Debugging Instructions
227-
* Use the Python debugger, set the name of the startup program
228-
229-
230235
## Source
231236

232237
[Github](https://github.com/DonJayamanne/pythonVSCode)

0 commit comments

Comments
 (0)