Skip to content

Commit

Permalink
fix: Update Getting Started docs (#815)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jason3S committed Dec 29, 2023
1 parent eee45cc commit cb1a452
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions extensions/win32/README.md
Expand Up @@ -8,6 +8,26 @@ Imports the Win32 spell checking dictionary for [Code Spell Checker](https://mar

This extension will automatically include [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) extension.

## Getting Started

By default the `win32` dictionary is enabled for `C` and `C++` file types. To enable it for other file types, it is necessary to add it to the `dictionaries` section of the configuration or include it as an inline CSpell directive: `cspell:dictionaries win32`.

Example: `example.md`

````markdown
Sample Code:

```cpp
// Parse the command line parameters
int argc;
LPWSTR* argv = CommandLineToArgvW(GetCommandLineW(), &argc);
pSample->ParseCommandLineArgs(argv, argc);
LocalFree(argv);
```

<!--- cspell:dictionaries win32 --->
````

<!--- @@inject: ../../static/footer.md --->

<br/>
Expand Down

0 comments on commit cb1a452

Please sign in to comment.