Skip to content

Commit

Permalink
fix: Update README (#2862)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jason3S authored Dec 30, 2023
1 parent f0eacb9 commit bd9a9db
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion dictionaries/win32/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,15 @@ Manual installation is useful if you want to include this dictionary as part of
npm i @cspell/dict-win32
```

The `cspell-ext.json` file in this package should be added to the import section in your `cspell.json` file.
The `cspell-ext.json` file in this package should be added to the import section in your CSpell configuration file.

**_`cspell.config.yaml`_**

```yaml
import: ['@cspell/dict-win32/cspell-ext.json']
```
**`cspell.json`**

```javascript
{
Expand All @@ -44,6 +52,26 @@ The `cspell-ext.json` file in this package should be added to the import section
}
```

## Enable the Dictionary

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 --->
````

# Dictionary Development

See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
Expand Down

0 comments on commit bd9a9db

Please sign in to comment.