Skip to content

Commit 1d00c2a

Browse files
committed
Added usage instructions to README
Closes #1. Signed-off-by: Gigabyte-Giant <[email protected]>
1 parent 5a821db commit 1d00c2a

File tree

2 files changed

+31
-4
lines changed

2 files changed

+31
-4
lines changed

README.md

+30-3
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,36 @@ Yes, I also have an opinion about this extension, but I won't offer-it-up, becau
1919

2020
### **tl;dr**: You'll have to try this, and "answer" that question for yourself.
2121

22-
## How do I use this?
23-
24-
- Coming soon...
22+
## How do I use this? (In 10 easy steps)
23+
**Note**: This section makes the assumption that you have a working installation of Visual Studio Code, and are mildly familiar with it. If you aren't, perhaps you should start [here](https://code.visualstudio.com/Docs).
24+
25+
### Step 0: Open a project in Visual Studio Code
26+
### Step 1: Launch the "Quick Open" Interface (`Ctrl/Cmd + P`)
27+
### Step 2: Install the extension using "`ext install vscode-file-header-comment-helper`"
28+
### Step 3: Restart VS Code when prompted
29+
### Step 4: Open your user [or workspace] settings file ([reference](https://code.visualstudio.com/Docs/customization/userandworkspace))
30+
### Step 5: Add the "`fileHeaderCommentHelper.languageConfigs`" property to your settings (see below)
31+
### Step 6: Add per-language file-header-comment templates (see below)
32+
### Step 7: Open a file [from the project you just opened]
33+
### Step 8: Re-Launch the "Quick Open" Interface (`Ctrl/Cmd + P`)
34+
### Step 9: Run the extension using "`> Insert File-Header-Comment`"
35+
36+
#### Example `settings.json` file, with extension configuration:
37+
```json
38+
// Place your settings in this file to overwrite the default settings
39+
{
40+
"fileHeaderCommentHelper.languageConfigs": {
41+
"language_javascript": {
42+
"template": [
43+
"/*",
44+
" * Project: $(projectName)",
45+
" * File: $(currentFile)",
46+
" */"
47+
]
48+
}
49+
}
50+
}
51+
```
2552

2653
## License
2754
This extension is released under an MIT License (just like [Visual Studio Code](https://code.visualstudio.com/)).

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "vscode-file-header-comment-helper",
33
"displayName": "File-Header-Comment Helper for Visual Studio Code",
44
"description": "An extension [for Visual Studio Code], that was created to help simplify the task of adding file-header comments to source code.",
5-
"version": "0.1.0",
5+
"version": "0.2.0",
66
"license": "MIT",
77
"author": {
88
"name": "Brynden \"Gigabyte Giant\" Bielefeld",

0 commit comments

Comments
 (0)