chore: Update README.md (#4945)

github-actions[bot] · Jason3S · web-flow · commit b4bb09a1a647 · 2025-11-07T18:39:13.000+01:00
Co-authored-by: Jason3S &lt;3740137+Jason3S@users.noreply.github.com&gt;
diff --git a/README.md b/README.md
@@ -132,6 +132,7 @@ Various [cspell](https://github.com/streetsidesoftware/cspell) dictionaries. Eac
 - [TypeScript/JavaScript](dictionaries/typescript) - TypeScript and JavaScript dictionary. <sup>1</sup>
 - [Vue](dictionaries/vue) - CSpell configuration for VUE files <sup>1</sup>
 - [Win32](dictionaries/win32) - Win32 dictionary.
+- [Zig](dictionaries/zig) - Zig dictionary for cspell.
 
 ## Specialized Dictionaries
 
@@ -290,6 +291,7 @@ Various [cspell](https://github.com/streetsidesoftware/cspell) dictionaries. Eac
 | [@cspell/dict-vim](./dictionaries/vim#readme)                                                   | Vim                               | vim                                                                                                                                                                                                                     |
 | [@cspell/dict-vue](./dictionaries/vue#readme)<sup>1</sup>                                       | Vue                               |                                                                                                                                                                                                                         |
 | [@cspell/dict-win32](./dictionaries/win32#readme)                                               | Win32                             | win32                                                                                                                                                                                                                   |
+| [@cspell/dict-zig](./dictionaries/zig#readme)                                                   | Zig                               | zig                                                                                                                                                                                                                     |
 
 <sup>1</sup> Bundled with CSpell.<br><sup>2</sup> Dictionaries are enabled when packages is imported.
 
@@ -435,6 +437,7 @@ Various [cspell](https://github.com/streetsidesoftware/cspell) dictionaries. Eac
 | [`vim`](dictionaries/vim)                                                            | Vim dictionary.                                                     |                               |                                                                |
 | [`web-services`](dictionaries/software-terms) <sup>1</sup> <sup>2</sup>              | Web Services and APIs dictionary.                                   |                               |                                                                |
 | [`win32`](dictionaries/win32)                                                        | Win32 dictionary.                                                   | -                             | c<br>cpp                                                       |
+| [`zig`](dictionaries/zig)                                                            | Zig dictionary for cspell.                                          | -                             | zig<br>zon                                                     |
 
 <sup>1</sup> Bundled with CSpell.<br> <sup>2</sup> Dictionaries are enabled when packages is imported.
 
@@ -553,7 +556,6 @@ Special thanks to all of our amazing contributors!
 [<img alt="Contributor Peterdedecker" src="https://avatars.githubusercontent.com/u/2641214?v=4&size=128" width=64>](https://github.com/Peterdedecker)
 [<img alt="Contributor sherpalabsio" src="https://avatars.githubusercontent.com/u/1914993?v=4&size=128" width=64>](https://github.com/sherpalabsio)
 [<img alt="Contributor thegraffix" src="https://avatars.githubusercontent.com/u/57874058?v=4&size=128" width=64>](https://github.com/thegraffix)
-[<img alt="Contributor ADTC" src="https://avatars.githubusercontent.com/u/6047296?v=4&size=128" width=64>](https://github.com/ADTC)
 [<img alt="Contributor Androlax2" src="https://avatars.githubusercontent.com/u/39646949?v=4&size=128" width=64>](https://github.com/Androlax2)
 [<img alt="Contributor ChocolateLoverRaj" src="https://avatars.githubusercontent.com/u/52586855?v=4&size=128" width=64>](https://github.com/ChocolateLoverRaj)
 [<img alt="Contributor cylewaitforit" src="https://avatars.githubusercontent.com/u/54253392?v=4&size=128" width=64>](https://github.com/cylewaitforit)
@@ -572,6 +574,7 @@ Special thanks to all of our amazing contributors!
 [<img alt="Contributor mhasanmeet" src="https://avatars.githubusercontent.com/u/24842666?v=4&size=128" width=64>](https://github.com/mhasanmeet)
 [<img alt="Contributor mhf-ir" src="https://avatars.githubusercontent.com/u/1172526?v=4&size=128" width=64>](https://github.com/mhf-ir)
 [<img alt="Contributor mmmarcos" src="https://avatars.githubusercontent.com/u/786907?v=4&size=128" width=64>](https://github.com/mmmarcos)
+[<img alt="Contributor mnemotic" src="https://avatars.githubusercontent.com/u/4642186?v=4&size=128" width=64>](https://github.com/mnemotic)
 [<img alt="Contributor Mo-Gul" src="https://avatars.githubusercontent.com/u/17992976?v=4&size=128" width=64>](https://github.com/Mo-Gul)
 [<img alt="Contributor msftenhanceprovenance" src="https://avatars.githubusercontent.com/u/85908596?v=4&size=128" width=64>](https://github.com/msftenhanceprovenance)
 [<img alt="Contributor niiccolas" src="https://avatars.githubusercontent.com/u/40167702?v=4&size=128" width=64>](https://github.com/niiccolas)
@@ -604,6 +607,7 @@ Special thanks to all of our amazing contributors!
 [<img alt="Contributor zhenzhenChange" src="https://avatars.githubusercontent.com/u/51586637?v=4&size=128" width=64>](https://github.com/zhenzhenChange)
 [<img alt="Contributor zilayo" src="https://avatars.githubusercontent.com/u/84344709?v=4&size=128" width=64>](https://github.com/zilayo)
 [<img alt="Contributor adam-zielonka" src="https://avatars.githubusercontent.com/u/31104775?v=4&size=128" width=64>](https://github.com/adam-zielonka)
+[<img alt="Contributor ADTC" src="https://avatars.githubusercontent.com/u/6047296?v=4&size=128" width=64>](https://github.com/ADTC)
 [<img alt="Contributor afifvdin" src="https://avatars.githubusercontent.com/u/94339143?v=4&size=128" width=64>](https://github.com/afifvdin)
 [<img alt="Contributor AhmedAlaa4611" src="https://avatars.githubusercontent.com/u/92916738?v=4&size=128" width=64>](https://github.com/AhmedAlaa4611)
 [<img alt="Contributor alcapitan" src="https://avatars.githubusercontent.com/u/60216981?v=4&size=128" width=64>](https://github.com/alcapitan)
@@ -637,7 +641,6 @@ Special thanks to all of our amazing contributors!
 [<img alt="Contributor jntesteves" src="https://avatars.githubusercontent.com/u/133886?v=4&size=128" width=64>](https://github.com/jntesteves)
 [<img alt="Contributor jorispoppe" src="https://avatars.githubusercontent.com/u/55499721?v=4&size=128" width=64>](https://github.com/jorispoppe)
 [<img alt="Contributor jpbernius" src="https://avatars.githubusercontent.com/u/6382716?v=4&size=128" width=64>](https://github.com/jpbernius)
-[<img alt="Contributor NutCr4cker12" src="https://avatars.githubusercontent.com/u/44898642?v=4&size=128" width=64>](https://github.com/NutCr4cker12)
 [<img alt="Contributor PaperbagWriter" src="https://avatars.githubusercontent.com/u/8887121?v=4&size=128" width=64>](https://github.com/PaperbagWriter)
 [<img alt="Contributor pepelsbey" src="https://avatars.githubusercontent.com/u/105274?v=4&size=128" width=64>](https://github.com/pepelsbey)
 [<img alt="Contributor rabchev" src="https://avatars.githubusercontent.com/u/1876061?v=4&size=128" width=64>](https://github.com/rabchev)
@@ -672,6 +675,7 @@ Special thanks to all of our amazing contributors!
 [<img alt="Contributor lukasfro" src="https://avatars.githubusercontent.com/u/1529698?v=4&size=128" width=64>](https://github.com/lukasfro)
 [<img alt="Contributor magnushiie" src="https://avatars.githubusercontent.com/u/734170?v=4&size=128" width=64>](https://github.com/magnushiie)
 [<img alt="Contributor ndthanhdev" src="https://avatars.githubusercontent.com/u/16331812?v=4&size=128" width=64>](https://github.com/ndthanhdev)
+[<img alt="Contributor NutCr4cker12" src="https://avatars.githubusercontent.com/u/44898642?v=4&size=128" width=64>](https://github.com/NutCr4cker12)
 [<img alt="Contributor Poikilos" src="https://avatars.githubusercontent.com/u/7557867?v=4&size=128" width=64>](https://github.com/Poikilos)
 [<img alt="Contributor rdsedmundo" src="https://avatars.githubusercontent.com/u/5482378?v=4&size=128" width=64>](https://github.com/rdsedmundo)
 [<img alt="Contributor TakumaKurosawa" src="https://avatars.githubusercontent.com/u/39955827?v=4&size=128" width=64>](https://github.com/TakumaKurosawa)
diff --git a/dictionaries/zig/README.md b/dictionaries/zig/README.md
@@ -6,10 +6,148 @@ This is a pre-built dictionary for use with CSpell.
 
 <!--- @@inject: ../../static/requirements.md --->
 
+## Requirements
+
+| Tool                                                                                                                                 | Version |
+| ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
+| [cspell](https://github.com/streetsidesoftware/cspell)                                                                               | `>= 8`  |
+| [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 4`  |
+
+<!--- @@inject-end: ../../static/requirements.md --->
+
 <!--- @@inject: ./static/install.md --->
 
+## Local Installation
+
+```sh
+npm install -D @cspell/dict-zig
+```
+
+## Configuration
+
+<details>
+<summary>VSCode Settings</summary>
+
+Add the following to your VSCode settings:
+
+**`.vscode/settings.json`**
+
+```jsonc
+{
+  "cSpell.import": ["@cspell/dict-zig/cspell-ext.json"],
+  "cSpell.dictionaries": ["zig"],
+}
+```
+
+</details>
+
+<details>
+<summary>CSpell Settings <code>cspell.json</code></summary>
+
+**`cspell.json`**
+
+```jsonc
+{
+  "import": ["@cspell/dict-zig/cspell-ext.json"],
+  "dictionaries": ["zig"],
+}
+```
+
+</details>
+
+<details>
+<summary>CSpell Settings <code>cspell.config.yaml</code></summary>
+
+**`cspell.config.yaml`**
+
+```yaml
+import:
+  - '@cspell/dict-zig/cspell-ext.json'
+dictionaries:
+  - zig
+```
+
+</details>
+
+## Local Installation using CDN
+
+## CDN Configuration
+
+<details>
+<summary>VSCode Settings</summary>
+
+Add the following to your VSCode settings:
+
+**`.vscode/settings.json`**
+
+```jsonc
+{
+  "cSpell.import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-zig/cspell-ext.json"],
+  "cSpell.dictionaries": ["zig"],
+}
+```
+
+</details>
+
+<details>
+<summary>CSpell Settings <code>cspell.json</code></summary>
+
+**`cspell.json`**
+
+```jsonc
+{
+  "import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-zig/cspell-ext.json"],
+  "dictionaries": ["zig"],
+}
+```
+
+</details>
+
+<details>
+<summary>CSpell Settings <code>cspell.config.yaml</code></summary>
+
+**`cspell.config.yaml`**
+
+```yaml
+import:
+  - https://cdn.jsdelivr.net/npm/@cspell/dict-zig/cspell-ext.json
+dictionaries:
+  - zig
+```
+
+</details>
+
+## Dictionary Information
+
+| Name  | Enabled | Description                |
+| ----- | ------- | -------------------------- |
+| `zig` |         | Zig dictionary for cspell. |
+
+## Language Settings
+
+| Name  | Locale | File Type |
+| ----- | ------ | --------- |
+| `zig` | `*`    | `zig`     |
+| `zig` | `*`    | `zon`     |
+
+<!--- @@inject-end: ./static/install.md --->
+
 <!--- @@inject: ../../static/contributing.md --->
 
+## Contributing
+
+Please help correct any mistakes in the dictionaries.
+
+See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)
+
+Special thanks to all of our amazing contributors!
+
+### Dictionary Development
+
+See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
+
+<!--- @@inject-end: ../../static/contributing.md --->
+
 ## License
 
 MIT
@@ -23,3 +161,15 @@ Code samples in the `samples/` directory taken from the [Zig standard library](h
 licensed under the terms of the MIT license.
 
 <!--- @@inject: ../../static/footer.md --->
+
+<br/>
+
+---
+
+<p align="center">
+Brought to you by <a href="https://streetsidesoftware.com" title="Street Side Software">
+<img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software
+</a>
+</p>
+
+<!--- @@inject-end: ../../static/footer.md --->
diff --git a/dictionaries/zig/static/example.cspell.config.yaml b/dictionaries/zig/static/example.cspell.config.yaml
@@ -0,0 +1,4 @@
+import:
+  - https://cdn.jsdelivr.net/npm/@cspell/dict-zig/cspell-ext.json
+dictionaries:
+  - zig
diff --git a/dictionaries/zig/static/example.cspell.json b/dictionaries/zig/static/example.cspell.json
@@ -0,0 +1,4 @@
+{
+    "import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-zig/cspell-ext.json"],
+    "dictionaries": ["zig"]
+}
diff --git a/dictionaries/zig/static/install.md b/dictionaries/zig/static/install.md
@@ -0,0 +1,112 @@
+## Local Installation
+
+```sh
+npm install -D @cspell/dict-zig
+```
+
+## Configuration
+
+<details>
+<summary>VSCode Settings</summary>
+
+Add the following to your VSCode settings:
+
+**`.vscode/settings.json`**
+
+```jsonc
+{
+  "cSpell.import": ["@cspell/dict-zig/cspell-ext.json"],
+  "cSpell.dictionaries": ["zig"],
+}
+```
+
+</details>
+
+<details>
+<summary>CSpell Settings <code>cspell.json</code></summary>
+
+**`cspell.json`**
+
+```jsonc
+{
+  "import": ["@cspell/dict-zig/cspell-ext.json"],
+  "dictionaries": ["zig"],
+}
+```
+
+</details>
+
+<details>
+<summary>CSpell Settings <code>cspell.config.yaml</code></summary>
+
+**`cspell.config.yaml`**
+
+```yaml
+import:
+  - '@cspell/dict-zig/cspell-ext.json'
+dictionaries:
+  - zig
+```
+
+</details>
+
+## Local Installation using CDN
+
+## CDN Configuration
+
+<details>
+<summary>VSCode Settings</summary>
+
+Add the following to your VSCode settings:
+
+**`.vscode/settings.json`**
+
+```jsonc
+{
+  "cSpell.import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-zig/cspell-ext.json"],
+  "cSpell.dictionaries": ["zig"],
+}
+```
+
+</details>
+
+<details>
+<summary>CSpell Settings <code>cspell.json</code></summary>
+
+**`cspell.json`**
+
+```jsonc
+{
+  "import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-zig/cspell-ext.json"],
+  "dictionaries": ["zig"],
+}
+```
+
+</details>
+
+<details>
+<summary>CSpell Settings <code>cspell.config.yaml</code></summary>
+
+**`cspell.config.yaml`**
+
+```yaml
+import:
+  - https://cdn.jsdelivr.net/npm/@cspell/dict-zig/cspell-ext.json
+dictionaries:
+  - zig
+```
+
+</details>
+
+## Dictionary Information
+
+| Name  | Enabled | Description                |
+| ----- | ------- | -------------------------- |
+| `zig` |         | Zig dictionary for cspell. |
+
+## Language Settings
+
+| Name  | Locale | File Type |
+| ----- | ------ | --------- |
+| `zig` | `*`    | `zig`     |
+| `zig` | `*`    | `zon`     |
diff --git a/dictionaries/zig/static/vscode-settings.json b/dictionaries/zig/static/vscode-settings.json
@@ -0,0 +1,4 @@
+{
+    "cSpell.import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-zig/cspell-ext.json"],
+    "cSpell.dictionaries": ["zig"]
+}
diff --git a/static/contributors.json b/static/contributors.json
@@ -937,6 +937,13 @@
     "contributions": 1,
     "type": "User"
   },
+  {
+    "login": "mnemotic",
+    "html_url": "https://github.com/mnemotic",
+    "avatar_url": "https://avatars.githubusercontent.com/u/4642186?v=4",
+    "contributions": 1,
+    "type": "User"
+  },
   {
     "login": "Mo-Gul",
     "html_url": "https://github.com/Mo-Gul",
diff --git a/static/contributors.md b/static/contributors.md
diff --git a/static/dictionary-packages.json b/static/dictionary-packages.json
diff --git a/static/dictionary-packages.md b/static/dictionary-packages.md

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +import:
 +  - https://cdn.jsdelivr.net/npm/@cspell/dict-zig/cspell-ext.json
 +dictionaries:
 +  - zig