chore: untrack victoria doc

Author: bradflaugher

.gitignore

@@ -1,11 +1,10 @@
 # crush-specific stuff
 .crush/
+VICTORIA.md
 
 # THIS GETS TEMPLATED vvv
 crush.json
 
-# VICTORIA.md master is kept in victoria-main
-VICTORIA.md
 
 # mac BS
 .DS_Store

README.md

@@ -97,6 +97,12 @@ python3 victoria.py
 This gives you the most control and is the same across macOS, Linux, and Windows (PowerShell).
 All modes store configuration and data in `~/Victoria` (or `%USERPROFILE%\Victoria` on Windows).
 
+To refresh the bundled `VICTORIA.md` knowledge base during development, run:
+
+```bash
+python3 victoria.py --dev
+```
+
 #### Customizing the launch tool
 
 Victoria uses the `crush` CLI by default. Set the following environment variables to swap in a different tool or config files:
@@ -140,17 +146,19 @@ After that, it’s double-click and go.
 
 ## 📦 Packaging for macOS and Windows
 
-You can build standalone packages so Victoria can be launched without a terminal.
+You can build standalone packages so Victoria can be launched from Finder. The macOS app opens a terminal window for interaction.
 
 ### macOS `.app`
 
+Before packaging, fetch `VICTORIA.md` from its private repository and place it in the project root. It is ignored by git.
+
 1. Run:
 
    ```bash
    ./package_mac.sh
    ```
 
-   The script uses `uvx pyinstaller`, so no `pip install` is required. The bundle will be created at `dist/Victoria.app`.
+   The script uses `uvx pyinstaller`, so no `pip install` is required. The bundle will be created at `dist/Victoria.app`. It bundles `CRUSH.md`, `VICTORIA.md`, `crush.template.json`, `snowflake.mcp.json`, and `.crushignore` for runtime reference.
 
 2. Share the app internally by either wrapping it in a DMG or zipping the bundle:
 
@@ -170,6 +178,8 @@ You can build standalone packages so Victoria can be launched without a terminal
 
 ### Windows `.exe` and Installer
 
+Before packaging, fetch `VICTORIA.md` from its private repository and place it in the project root. It is ignored by git.
+
 1. Install [Inno Setup](https://jrsoftware.org/isinfo.php) (make sure `iscc` is on your PATH). PyInstaller is invoked via `uvx`, so you don't need to install it.
 2. To change the installer version, edit `installer_win.iss` and update `MyAppVersion` on line 2.
 3. Run `package_win.bat` from Command Prompt or PowerShell:
@@ -178,7 +188,7 @@ You can build standalone packages so Victoria can be launched without a terminal
    .\package_win.bat
    ```
 
-   This produces both a standalone executable (`dist/Victoria.exe`) and an installer (`dist/VictoriaSetup.exe`).
+   This produces both a standalone executable (`dist/Victoria.exe`) and an installer (`dist/VictoriaSetup.exe`). The build bundles `CRUSH.md` and `VICTORIA.md` alongside the configuration templates for runtime reference.
 
 To upgrade Victoria on Windows, build a new installer with an updated version number and run it; Inno Setup will replace the previous installation automatically while preserving the same AppId.
 Both packaged versions automatically use the `~/Victoria` folder (or `%USERPROFILE%\Victoria` on Windows) for configuration and data.

package_mac.sh

@@ -1,8 +1,10 @@
 #!/usr/bin/env bash
 set -e
-uvx pyinstaller --noconfirm --windowed --name Victoria \
+uvx pyinstaller --noconfirm --console --name Victoria \
   --icon assets/icon.icns \
   --add-data "crush.template.json:." \
   --add-data "snowflake.mcp.json:." \
   --add-data ".crushignore:." \
+  --add-data "CRUSH.md:." \
+  --add-data "VICTORIA.md:." \
   victoria.py

package_win.bat

@@ -4,6 +4,8 @@ uvx pyinstaller --noconfirm --onefile --name Victoria ^
   --add-data "crush.template.json;." ^
   --add-data "snowflake.mcp.json;." ^
   --add-data ".crushignore;." ^
+  --add-data "CRUSH.md;." ^
+  --add-data "VICTORIA.md;." ^
   victoria.py
 REM Build installer with Inno Setup (iscc must be on PATH)
 iscc installer_win.iss

victoria.py

@@ -12,6 +12,7 @@
 - Cross-platform terminal compatibility with graceful degradation
 """
 
+import argparse
 import json
 import os
 import re
@@ -44,12 +45,22 @@ def resource_path(name: str) -> Path:
     return base / name
 
 def ensure_default_files():
-    for fname in [".crushignore", "CRUSH.md"]:
+    for fname in [".crushignore", "CRUSH.md", VICTORIA_FILE]:
         src = resource_path(fname)
         dst = APP_HOME / fname
         if src.exists() and not dst.exists():
             shutil.copy(src, dst)
 
+
+def parse_args():
+    parser = argparse.ArgumentParser(description="Victoria launcher")
+    parser.add_argument(
+        "--dev",
+        action="store_true",
+        help="Enable developer mode to refresh VICTORIA.md",
+    )
+    return parser.parse_args()
+
 SNOWFLAKE_ENV_VARS = [
     "SNOWFLAKE_ACCOUNT",
     "SNOWFLAKE_USER",
@@ -700,6 +711,9 @@ def open_victoria_folder():
         warn(f"Could not open Victoria folder: {e}")
 
 def main():
+    args = parse_args()
+    dev_mode = args.dev or os.environ.get("VICTORIA_DEV") == "1"
+
     ensure_default_files()
     clear_screen()
     banner()
@@ -716,8 +730,10 @@ def main():
         print(f"{T.DIM}Debug: Terminal caps: {TERM_CAPS}{T.NC}")
 
     time.sleep(1)
-    
-    prompt_update_victoria()
+
+    if dev_mode:
+        prompt_update_victoria()
+
     preflight()
 
     choice = course_menu()