From 52edb2f65a6fd21b98f69f07d9a68381c7f6db4d Mon Sep 17 00:00:00 2001 From: Jason Dent Date: Fri, 29 Dec 2023 11:33:50 +0100 Subject: [PATCH] fix: Update Getting Started docs --- extensions/win32/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/extensions/win32/README.md b/extensions/win32/README.md index ec6f1939..3482e7e9 100644 --- a/extensions/win32/README.md +++ b/extensions/win32/README.md @@ -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); +``` + + +```` +