Skip to content

Commit 7dab5f9

Browse files
committed
Add GIFs to the README.md
Add some GIFs from the walkthrough to the README.md file to showcase some key features of the extension.
1 parent 320b378 commit 7dab5f9

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,30 @@
11
# Swift for Visual Studio Code
22

3-
This extension adds language support for Swift to Visual Studio Code, providing a seamless experience for developing Swift applications on all supported platforms. It supports:
3+
This extension adds language support for Swift to Visual Studio Code, providing a seamless experience for developing Swift applications on all supported platforms. It supports features such as:
44

55
* Code completion
6-
* Jump to definition, peek definition, find all references, symbol search
7-
* Error annotations and apply suggestions from errors
6+
* Jump to definition, peek definition, find all references and symbol search
7+
* Error annotations and fix suggestions
88
* Automatic generation of launch configurations for debugging with [LLDB DAP](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.lldb-dap)
99
* Automatic task creation
10-
* Package dependency view
10+
* A Project Panel to quickly run actions and view dependencies
1111
* Test Explorer view
1212

1313
> **Note**
1414
> Most features of the Swift for Visual Studio Code extension only work with projects that build with Swift Package Manager. These projects will have a `Package.swift` file in their root folder. Support for Xcode projects (`.xcodeproj`) is limited.
1515
16+
### Creating New Projects
17+
<img src="assets/walkthrough/images/createNewProject.gif" width="700">
18+
19+
### Running Executables
20+
<img src="assets/walkthrough/images/runExecutable.gif" width="700">
21+
22+
### Debugging Executables
23+
<img src="assets/walkthrough/images/debugExecutable.gif" width="700">
24+
25+
### Running Tests
26+
<img src="assets/walkthrough/images/runTests.gif" width="700">
27+
1628
# Documentation
1729

1830
The [getting started guide](https://www.swift.org/documentation/articles/getting-started-with-vscode-swift.html) and [official documentation](https://docs.swift.org/vscode/documentation/userdocs) for this extension are available on [swift.org](https://www.swift.org).

0 commit comments

Comments
 (0)