chore: clean up documentation

Author: RuntimeRascal

Installer/ISSUES.md

@@ -61,35 +61,22 @@ msiexec /i GhostDrawSetup-v1.1.0.msi /l*v upgrade.log
 ## Features
 
 The installer supports:
-- ? Install to Program Files
-- ? Optional Start Menu shortcut (default: yes)
-- ? Optional Desktop shortcut (default: no)
-- ? Optional Run at Startup (default: no)
-- ? Clean uninstall (removes files, shortcuts, registry)
-- ? In-place upgrades (preserves user settings)
-- ? Downgrade prevention
-- ? Launch app after installation
+- ✅ Install to Program Files
+- ✅ Clean uninstall (removes files, shortcuts, registry)
+- ✅ In-place upgrades (preserves user settings)
+- ✅ Downgrade prevention
+- ✅ Launch app after installation
 
 ## Upgrade Code
 
-?? **CRITICAL**: The UpgradeCode GUID in `Product.wxs` must **NEVER** change across versions:
+⚠️ **CRITICAL**: The UpgradeCode GUID in `Product.wxs` must **NEVER** change across versions:
 
 ```xml
 <?define UpgradeCode="A8B9C0D1-2E3F-4A5B-6C7D-8E9F0A1B2C3D" ?>
 ```
 
 Changing this GUID will break upgrade detection.
 
-## Versioning
-
-Update the version in `Product.wxs`:
-
-```xml
-<?define ProductVersion="1.0.0" ?>
-```
-
-Use semantic versioning: `MAJOR.MINOR.PATCH`
-
 ## Troubleshooting
 
 ### Build Errors
@@ -116,4 +103,3 @@ Common issues:
 
 - [WiX Documentation](https://wixtoolset.org/docs/)
 - [WiX Tutorial](https://www.firegiant.com/wix/tutorial/)
-- [Implementation Plan](../docs/installer-implementation-plan.md)

Installer/README.md

@@ -6,29 +6,17 @@ This directory contains the Windows Application Packaging Project for building M
 
 ### Local Development Build
 
-```powershell
-# 1. Generate test certificate (one-time)
-cd Package
-.\create-test-cert.ps1
-
-# 2. Install certificate as Administrator (one-time)
-.\install-cert.ps1
-
-# 3. Build MSIX package
-.\build-msix.ps1 -Version "2.0.0.0" -Configuration Debug
-
-# 4. Install locally for testing
-Add-AppxPackage -Path "AppPackages\GhostDraw.Package_2.0.0.0_x64_Debug_Test\GhostDraw.Package_2.0.0.0_x64_Debug.msix"
-
-# 5. Remove the installed package
-Get-AppxPackage -Name "*GhostDraw*" | Remove-AppxPackage
+```shell
+# Execute the npm script. Will ensure local certs, clean, build and install package locally for testing.
+npm run install:package
 ```
 
 ## Files
 
 - **GhostDraw.Package.wapproj** - Windows Application Packaging Project
 - **Package.appxmanifest** - App manifest with identity, capabilities, and visual elements
 - **build-msix.ps1** - Build automation script
+- **Package\Build-And-Install-MSIX.ps1** - Cleans builds and installs local package for testing
 - **create-test-cert.ps1** - Generates self-signed certificate for local testing
 - **install-cert.ps1** - Installs test certificate to Trusted Root (requires Admin)
 - **Generate-Assets.ps1** - Creates visual assets from source icon
@@ -54,7 +42,7 @@ Current assets are auto-generated placeholders from the main app icon. For produ
 
 1. **Build Store upload package**:
    ```powershell
-   .\build-msix.ps1 -Version "1.0.17" -Configuration Release -CreateUploadPackage
+   .\build-msix.ps1 -Version "1.0.0.0" -Configuration Release -CreateUploadPackage
    ```
 
 2. **Upload to Partner Center**:

NPM_SCRIPTS.md

@@ -22,8 +22,8 @@
 ## ✨ Features
 
 ### 🎨 **Drawing Tools**
-- **Multiple Drawing Tools** - Switch between Pen (freehand), Line (straight lines), Rectangle (boxes), Circle/Ellipse, and Eraser tools with keyboard shortcuts
-- **Perfect Shapes** - Hold Shift while using Circle tool to draw perfect circles
+- **Multiple Drawing Tools** - Switch between Pen (freehand), Line (straight lines), Rectangle (boxes), Circle/Ellipse, text, and Eraser tools with keyboard shortcuts
+- **Perfect Shapes** - Hold Shift while using Circle or Rectangle tool to draw perfect circles/rectangles
 - **Customizable Color Palette** - Create your own color collection and cycle through them while drawing
 - **Variable Brush Thickness** - Adjust brush size from 1-100px with configurable min/max ranges
 - **Smooth Drawing** - High-performance rendering for fluid strokes
@@ -41,7 +41,6 @@
 - **System Tray Integration** - Runs quietly in the background
 - **Emergency Exit** - Press `ESC` to instantly hide the overlay
 - **Right-Click Color Cycling** - Quickly switch between your palette colors
-- **Position-Numbered Palette** - Easily organize and reorder your favorite colors
 
 ---
 

Package/README.md

@@ -1,22 +1,5 @@
 # TODO List
 
-## Phase One
-- [X] Settings window settings persist. The window needs to look modern and have innovative design that matches the name of the app and what it does. We can use the logo in Assets and the window should not have the default windows title bar instead look much more modern. Use a fancy gradient as the window background.
-- [X] Custom ghost/pencil icon in the system tray.
-- [X] Allow changing the color of the drawing. Can change in settings that persist. Allow cycling through color options by right clicking on the mouse.
-- [X] Allow changing the size/brush thickness of the drawing. Can change in settings that persist. Allow increasing/decreasing the size with the scroll wheel. 
-- [X] Have a max and a min size setting.
-- [X] Create custom colored pencil cursor. The cursor will have the tip colored to match the currently drawing color.
-- [X] Settings allows choosing keyboard combo to activate drawing mode.
-- [X] Setting to lock drawing mode. If drawing mode is locked setting is true when press key combo we lock the drawing mode in and no longer require user to hold the combo. Drawing mode continues until the user presses the key combo again or ESC is pressed.
-
-## Phase Two
-- [X] Get the settings window glow effect working.
-- [X] Add feature to allow erasing. while in drawing mode, pressing and releasing `e` activated eraser mode.cursor needs to change to a custom eraser cursor.
-- [X] Add feature to allow drawing a line. while in drawing mode, pressing and releasing `l` activated drawLine mode.
-- [X] Add feature to allow drawing a square. while in drawing mode, pressing and releasing `s` activated drawSquare mode.
-- [X] Add feature to allow drawing a circle. while in drawing mode, pressing and releasing `c` activated drawCircle mode.
-- [X] Add feature to allow typing text.
 - [ ] Add new setting to persist drawings. If enabled drawings will persist across draw mode activations. So if activate draw mode then draw on overlays then deactivate draw mode the drawings will persist when you re-activate draw mode again. Pretty much we don't clear drawings in this mode. We leave clearing or undoing drawings to the user.
 - [ ] Screen save ctrl+s should prompt user for which screen to save. When ctrl+s is pressed drawing is temporarily disabled and a modal prompts user to select which screen to save or save all. Once user selects something, the modal closes then the chosen screen is saved. We have a delete key function that clears all drawings and this function opens a modal to prompt user while disabling drawing so that the user can interact with the modal. We will be doing something similar to this.