clean up before build

.gitignore

@@ -13,3 +13,7 @@ manifest.ini
 *.nvda-addon
 .sconsign.dblite
 /[0-9]*.[0-9]*.[0-9]*.json
+
+.ruff_cache/
+.mypy_cache/
+__pycache__/

docs/src/ATTRIBUTIONS.md

@@ -34,6 +34,12 @@
   - Document Formatting: "Line Indentation Reporting" set to "Tones"
   - Scratchpad located within the NVDA advanced settings, there you can import python scripts during developmentBlunder
   - Disable insert as a modifier key in order to work with Rango
+- NVDA Addon Build Process
+  - Copyright (C) 2012-2023 NVDA Add-on team contributors.
+    This package is distributed under the terms of the GNU General Public License, version 2 or later. Please see the file COPYING.txt for further details.
+    [alekssamos](https://github.com/alekssamos/) added automatic package of add-ons through Github Actions.
+    For details about Github Actions please see the [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions).
+    Copyright (C) 2022 alekssamos
 
 ## JAWS
 

nvda/.addOn/sight-free-talon-server/buildVars.py

@@ -20,20 +20,22 @@ def _(arg):
     # Add-on summary, usually the user visible name of the addon.
     # Translators: Summary for this add-on
     # to be shown on installation and add-on information found in Add-ons Manager.
-    "addon_summary": _("Sight-Free-Talon"),
+    "addon_summary": _(
+        "Recieve and process commands from the Talon Voice dictation engine"
+    ),
     # Add-on description
     # Translators: Long description to be shown for this add-on on add-on information from add-ons manager
     "addon_description": _(
-        """Server to Communicate With Talon Through the Screen Reader"""
+        "This addon provides a command server from recieving and processing commands sent from Talon Voice. It is tightly scoped and only permits changing settings for speech and interrupts."
     ),
     # version
-    "addon_version": "0.16",
+    "addon_version": "1.0",
     # Author(s)
     "addon_author": "Colton Loftus https://colton.bio/contact/",
     # URL for the add-on documentation support
     "addon_url": "https://colton.bio/sight-free-talon/",
     # URL for the add-on repository where the source code can be found
-    "addon_sourceURL": None,
+    "addon_sourceURL": "https://github.com/C-Loftus/sight-free-talon",
     # Documentation file name
     "addon_docFileName": "readme.html",
     # Minimum NVDA version supported (e.g. "2018.3.0", minor version is optional)

nvda/.addOn/sight-free-talon-server/copy_to_scratchpad.ps1

@@ -1,3 +1,5 @@
+# Used for testing the addon in NVDA and quickly updating the addon
+
 Set-Location $PSScriptRoot
 
 Copy-Item ".\addon\globalPlugins\nvda-addon.py" -Destination "$env:APPDATA\nvda\scratchpad\globalPlugins\sight-free-talon-server-tmp.py"

nvda/.addOn/sight-free-talon-server/readme.md

@@ -6,14 +6,8 @@ You do not need to install this addon to use NVDA alongside the general dictatio
 
 ## Installation
 
-For the time being, install the addon via the github release page. You can then simply install the addon by clicking on the file while NVDA is running. Note, please manually remove the old version of the addon before installing the new one, as I am not currently managing the version number in the addon until I reach a stable beta.
+First install the sight-free-talon NVDA addon with one click like any other NVDA addon.
 
-To install the client side of the addon, you will need to clone the sight-free-talon repo into your Talon user directory.
+Then you will need to install the client side of the addon, by cloning the sight-free-talon repo into your Talon user directory.
 
-# Attributions
 
-Copyright (C) 2012-2023 NVDA Add-on team contributors.
-This package is distributed under the terms of the GNU General Public License, version 2 or later. Please see the file COPYING.txt for further details.
-[alekssamos](https://github.com/alekssamos/) added automatic package of add-ons through Github Actions.
-For details about Github Actions please see the [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions).
-Copyright (C) 2022 alekssamos