documentation: vscode extension added

This commit is contained in:
Andreas Stallinger
2017-06-27 14:29:53 +02:00
parent 293a2a84c3
commit d60a9c82d5
2 changed files with 26 additions and 0 deletions
+8
View File
@@ -0,0 +1,8 @@
#vsce-sourcetrail
The VS Code extension source code is hosted at Github.
The extension is available in the marketplace,
to install it simple use the marketplace inside VS Code
Link to the repository: [vsce-sourcetrail](https://github.com/CoatiSoftware/vsce-sourcetrail).
+18
View File
@@ -1965,6 +1965,7 @@
<li>Sublime Text 2</li>
<li>Sublime Text 3</li>
<li>Vim</li>
<li>Visual Studio Code</li>
<li>Visual Studio 2012</li>
<li>Visual Studio 2013</li>
<li>Visual Studio 2015</li>
@@ -2157,6 +2158,23 @@
<code>:SourcetrailActivateToken</code>, now Sourcetrail should display your the chosen location.</p>
<p>Use<code>:help sourcetrail.txt</code> get get more information about the plugin</p>
<h3>VS Code</h3>
<strong>Repo</strong>
<p><a href="https://github.com/CoatiSoftware/vsce-sourcetrail">https://github.com/CoatiSoftware/vsce-sourcetrail</a></p>
<strong>Installation</strong>
<p>
<ol>
<li>In VS Code go to Extensions(<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd>)</li>
<li>Search for sourcetrail in the marketplace</li>
<li>Install sourcetrail</li>
</ol>
</p>
<strong>Use</strong>
<p>To start the Tcp Server go to the Command Pallete(<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>) and type: <code>Sourcetrail: (Re)start server</code></p>
<p>To send a location to Sourcetrail, place the cursor and right-click and select <code>Sourcetrail: Send Location</code>
or type in the Command Pallete: <code>Sourcetrail: Send Location</code></p>
<h3>Visual Studio</h3>
<strong>Installation</strong>
<p>To install the Sourcetrail plugin for Visual Studio 2012, 2013 or 2015, just execute the corresponding vsix file located in your <code>ide_plugins/visual_studio</code>.</p>