Skip to content

Commit a0614ec

Browse files
committed
Update the walkthrough
Add some GIFs and additional steps for running, debugging and DocC previewing. Issue: #1560
1 parent 09b18d9 commit a0614ec

16 files changed

+105
-22
lines changed

assets/walkthrough/createNewProject.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Create a New Swift Project
2+
![Create new project](./images/createNewProject.gif)
3+
14
There are several project templates to choose from:
25
- `Library`: A package with a library. Use this to publish code for other packages to consume.
36
- `Executable`: A package with an executable. Use this for command line utilities.
@@ -9,4 +12,10 @@ There are several project templates to choose from:
912

1013
Once you select a template, you'll be prompted to enter a name for your new project. This will be the name of the folder created in your workspace.
1114

12-
Finally, you'll be prompted to select a location for your new project. You can choose any location in your workspace, or create a new folder.
15+
Finally, you'll be prompted to select a location for your new project. You can choose any location in your workspace, or create a new folder.
16+
17+
![Open existing project](./images/openProject.gif)
18+
19+
When you open an existing project with a ``Package.swift`` file the extension will start automatically.
20+
21+
Tip: You can view more information about the toolchain and other configurations being used for the project by hovering over the `{}` icon in the status bar.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Swift Extension Settings
2+
3+
![Swift Extension Settings](./images/settings.gif)
4+
5+
The Swift Extension contains several settings you can customize.
6+
7+
## Workspace Settings
8+
9+
**Add details about custom workspace settings and environment variable here.**
10+
11+
## Inlay Hints
12+
13+
Some language settings such as those for inlay hints for inferred variable types are turned on by default in VS Code.
14+
15+
![Disable Inlay Hints](./images/disableInlayHints.gif)
16+
17+
You can turn off inlay hints for Swift by adding `[swift]` specific settings to your `settings.json` file:
18+
19+
```
20+
"[swift]": {
21+
"editor.inlayHints.enabled": "off"
22+
},
23+
```
1.43 MB
Loading
763 KB
Loading
Loading
532 KB
Loading
Loading
1.17 MB
Loading
830 KB
Loading
1.63 MB
Loading

0 commit comments

Comments
 (0)