Standardize naming to br-equipment-control-app across all platforms

Author: eldinmiller

.github/workflows/build.yml

@@ -30,13 +30,13 @@ jobs:
       - name: Create zip archive
         run: |
           cd dist
-          Compress-Archive -Path "BR-Equipment-Control" -DestinationPath "BR-Equipment-Control-Windows.zip"
+          Compress-Archive -Path "br-equipment-control-app" -DestinationPath "br-equipment-control-app-windows.zip"
 
       - name: Upload artifact
         uses: actions/upload-artifact@v4
         with:
           name: windows-build
-          path: dist/BR-Equipment-Control-Windows.zip
+          path: dist/br-equipment-control-app-windows.zip
 
   build-macos:
     runs-on: macos-latest
@@ -63,32 +63,32 @@ jobs:
           brew install create-dmg
           cd dist
           create-dmg \
-            --volname "BR Equipment Control" \
+            --volname "br-equipment-control-app" \
             --volicon "../assets/icon.png" \
             --window-pos 200 120 \
             --window-size 800 400 \
             --icon-size 100 \
-            --icon "BR Equipment Control.app" 200 190 \
-            --hide-extension "BR Equipment Control.app" \
+            --icon "br-equipment-control-app.app" 200 190 \
+            --hide-extension "br-equipment-control-app.app" \
             --app-drop-link 600 185 \
-            "BR-Equipment-Control-macOS.dmg" \
-            "BR Equipment Control.app"
+            "br-equipment-control-app-macos.dmg" \
+            "br-equipment-control-app.app"
         continue-on-error: true
 
       - name: Create zip fallback if DMG fails
         run: |
           cd dist
-          if [ ! -f "BR-Equipment-Control-macOS.dmg" ]; then
-            zip -r "BR-Equipment-Control-macOS.zip" "BR Equipment Control.app"
+          if [ ! -f "br-equipment-control-app-macos.dmg" ]; then
+            zip -r "br-equipment-control-app-macos.zip" "br-equipment-control-app.app"
           fi
 
       - name: Upload artifact
         uses: actions/upload-artifact@v4
         with:
           name: macos-build
           path: |
-            dist/BR-Equipment-Control-macOS.dmg
-            dist/BR-Equipment-Control-macOS.zip
+            dist/br-equipment-control-app-macos.dmg
+            dist/br-equipment-control-app-macos.zip
 
   build-linux:
     runs-on: ubuntu-latest
@@ -118,13 +118,13 @@ jobs:
       - name: Create tar.gz archive
         run: |
           cd dist
-          tar -czf BR-Equipment-Control-Linux.tar.gz BR-Equipment-Control/
+          tar -czf br-equipment-control-app-linux.tar.gz br-equipment-control-app/
 
       - name: Upload artifact
         uses: actions/upload-artifact@v4
         with:
           name: linux-build
-          path: dist/BR-Equipment-Control-Linux.tar.gz
+          path: dist/br-equipment-control-app-linux.tar.gz
 
   create-release:
     needs: [build-windows, build-macos, build-linux]
@@ -148,10 +148,10 @@ jobs:
         uses: softprops/action-gh-release@v1
         with:
           files: |
-            artifacts/windows-build/BR-Equipment-Control-Windows.zip
-            artifacts/macos-build/BR-Equipment-Control-macOS.dmg
-            artifacts/macos-build/BR-Equipment-Control-macOS.zip
-            artifacts/linux-build/BR-Equipment-Control-Linux.tar.gz
+            artifacts/windows-build/br-equipment-control-app-windows.zip
+            artifacts/macos-build/br-equipment-control-app-macos.dmg
+            artifacts/macos-build/br-equipment-control-app-macos.zip
+            artifacts/linux-build/br-equipment-control-app-linux.tar.gz
           draft: false
           prerelease: false
           generate_release_notes: true

BUILD.md

@@ -33,18 +33,18 @@ GitHub Actions will build executables for all three platforms and create a relea
 # Build the executable
 pyinstaller build.spec
 
-# The executable will be in: dist/BR-Equipment-Control/
+# The executable will be in: dist/br-equipment-control-app/
 # To create a zip for distribution:
 cd dist
-powershell Compress-Archive -Path "BR-Equipment-Control" -DestinationPath "BR-Equipment-Control-Windows.zip"
+powershell Compress-Archive -Path "br-equipment-control-app" -DestinationPath "br-equipment-control-app-windows.zip"
 ```
 
 The Windows build will:
 - Create a `.exe` file with no console window
 - Include the icon from `assets/icon.ico`
-- Bundle all dependencies in the `dist/BR-Equipment-Control/` folder
+- Bundle all dependencies in the `dist/br-equipment-control-app/` folder
 
-**Distribution:** Share the entire `BR-Equipment-Control` folder or the zip file. Users can run `BR-Equipment-Control.exe` directly.
+**Distribution:** Share the entire `br-equipment-control-app` folder or the zip file. Users can run `br-equipment-control-app.exe` directly.
 
 ---
 
@@ -54,21 +54,21 @@ The Windows build will:
 # Build the app bundle
 pyinstaller build.spec
 
-# The app will be in: dist/BR Equipment Control.app/
+# The app will be in: dist/br-equipment-control-app.app/
 # To create a DMG (requires create-dmg):
 brew install create-dmg
 cd dist
 create-dmg \
-  --volname "BR Equipment Control" \
+  --volname "br-equipment-control-app" \
   --volicon "../assets/icon.png" \
   --window-pos 200 120 \
   --window-size 800 400 \
   --icon-size 100 \
-  --icon "BR Equipment Control.app" 200 190 \
-  --hide-extension "BR Equipment Control.app" \
+  --icon "br-equipment-control-app.app" 200 190 \
+  --hide-extension "br-equipment-control-app.app" \
   --app-drop-link 600 185 \
-  "BR-Equipment-Control-macOS.dmg" \
-  "BR Equipment Control.app"
+  "br-equipment-control-app-macos.dmg" \
+  "br-equipment-control-app.app"
 ```
 
 The macOS build will:
@@ -91,18 +91,18 @@ sudo yum install python3-tkinter  # RHEL/CentOS
 # Build the executable
 pyinstaller build.spec
 
-# The executable will be in: dist/BR-Equipment-Control/
+# The executable will be in: dist/br-equipment-control-app/
 # To create a tarball:
 cd dist
-tar -czf BR-Equipment-Control-Linux.tar.gz BR-Equipment-Control/
+tar -czf br-equipment-control-app-linux.tar.gz br-equipment-control-app/
 ```
 
 The Linux build will:
 - Create an executable binary
 - Bundle all dependencies
 - Include all device modules and assets
 
-**Distribution:** Share the `.tar.gz` file. Users extract it and run `./BR-Equipment-Control` from the terminal.
+**Distribution:** Share the `.tar.gz` file. Users extract it and run `./br-equipment-control-app` from the terminal.
 
 ---
 

DISTRIBUTION.md

@@ -5,26 +5,26 @@
 Download the pre-built executable for your platform from the [Releases page](https://github.com/bluerobotics/br-equipment-control-app/releases):
 
 ### Windows
-1. Download `BR-Equipment-Control-Windows.zip`
+1. Download `br-equipment-control-app-windows.zip`
 2. Extract the zip file
-3. Run `BR-Equipment-Control.exe`
+3. Run `br-equipment-control-app.exe`
 4. On first run, you'll be prompted to select your `devices` folder location
    - **For development:** Point to your local git repo's devices folder
    - **For general use:** Use the bundled devices folder in the extracted directory
 
 ### macOS
-1. Download `BR-Equipment-Control-macOS.dmg`
+1. Download `br-equipment-control-app-macos.dmg`
 2. Open the DMG file
-3. Drag `BR Equipment Control.app` to your Applications folder
+3. Drag `br-equipment-control-app.app` to your Applications folder
 4. If you get a security warning, right-click the app and select "Open"
 5. On first run, you'll be prompted to select your `devices` folder location
    - **For development:** Point to your local git repo's devices folder
    - **For general use:** Create/select a folder with your device configs
 
 ### Linux
-1. Download `BR-Equipment-Control-Linux.tar.gz`
-2. Extract: `tar -xzf BR-Equipment-Control-Linux.tar.gz`
-3. Run: `cd BR-Equipment-Control && ./BR-Equipment-Control`
+1. Download `br-equipment-control-app-linux.tar.gz`
+2. Extract: `tar -xzf br-equipment-control-app-linux.tar.gz`
+3. Run: `cd br-equipment-control-app && ./br-equipment-control-app`
 4. If you get a "tkinter not found" error, install it:
    - Ubuntu/Debian: `sudo apt-get install python3-tk`
    - Fedora/RHEL: `sudo dnf install python3-tkinter`

build.bat

@@ -26,16 +26,16 @@ if errorlevel 1 (
 
 echo.
 echo Build complete!
-echo Executable location: dist\BR-Equipment-Control\BR-Equipment-Control.exe
+echo Executable location: dist\br-equipment-control-app\br-equipment-control-app.exe
 echo.
 echo Creating zip archive...
 cd dist
-powershell -Command "Compress-Archive -Path 'BR-Equipment-Control' -DestinationPath 'BR-Equipment-Control-Windows.zip' -Force"
+powershell -Command "Compress-Archive -Path 'br-equipment-control-app' -DestinationPath 'br-equipment-control-app-windows.zip' -Force"
 cd ..
 
 echo.
 echo Done! Distributable zip file created at:
-echo   dist\BR-Equipment-Control-Windows.zip
+echo   dist\br-equipment-control-app-windows.zip
 echo.
 pause
 

build.sh

@@ -42,52 +42,52 @@ echo "Build complete!"
 cd dist
 
 if [[ "$OS" == "macOS" ]]; then
-    echo "Executable location: dist/BR Equipment Control.app"
+    echo "Executable location: dist/br-equipment-control-app.app"
     echo ""
 
     # Try to create DMG if create-dmg is available
     if command -v create-dmg &> /dev/null; then
         echo "Creating DMG..."
         create-dmg \
-            --volname "BR Equipment Control" \
+            --volname "br-equipment-control-app" \
             --volicon "../assets/icon.png" \
             --window-pos 200 120 \
             --window-size 800 400 \
             --icon-size 100 \
-            --icon "BR Equipment Control.app" 200 190 \
-            --hide-extension "BR Equipment Control.app" \
+            --icon "br-equipment-control-app.app" 200 190 \
+            --hide-extension "br-equipment-control-app.app" \
             --app-drop-link 600 185 \
-            "BR-Equipment-Control-macOS.dmg" \
-            "BR Equipment Control.app"
+            "br-equipment-control-app-macos.dmg" \
+            "br-equipment-control-app.app"
 
         if [ $? -eq 0 ]; then
             echo ""
             echo "Done! Distributable DMG file created at:"
-            echo "  dist/BR-Equipment-Control-macOS.dmg"
+            echo "  dist/br-equipment-control-app-macos.dmg"
         else
             echo "DMG creation failed, creating zip instead..."
-            zip -r "BR-Equipment-Control-macOS.zip" "BR Equipment Control.app"
+            zip -r "br-equipment-control-app-macos.zip" "br-equipment-control-app.app"
             echo ""
             echo "Done! Distributable zip file created at:"
-            echo "  dist/BR-Equipment-Control-macOS.zip"
+            echo "  dist/br-equipment-control-app-macos.zip"
         fi
     else
         echo "create-dmg not found, creating zip..."
         echo "Tip: Install with: brew install create-dmg"
-        zip -r "BR-Equipment-Control-macOS.zip" "BR Equipment Control.app"
+        zip -r "br-equipment-control-app-macos.zip" "br-equipment-control-app.app"
         echo ""
         echo "Done! Distributable zip file created at:"
-        echo "  dist/BR-Equipment-Control-macOS.zip"
+        echo "  dist/br-equipment-control-app-macos.zip"
     fi
 
 elif [[ "$OS" == "Linux" ]]; then
-    echo "Executable location: dist/BR-Equipment-Control/BR-Equipment-Control"
+    echo "Executable location: dist/br-equipment-control-app/br-equipment-control-app"
     echo ""
     echo "Creating tarball..."
-    tar -czf BR-Equipment-Control-Linux.tar.gz BR-Equipment-Control/
+    tar -czf br-equipment-control-app-linux.tar.gz br-equipment-control-app/
     echo ""
     echo "Done! Distributable tarball created at:"
-    echo "  dist/BR-Equipment-Control-Linux.tar.gz"
+        echo "  dist/br-equipment-control-app-linux.tar.gz"
 fi
 
 cd ..

build.spec

@@ -78,7 +78,7 @@ exe = EXE(
     a.scripts,
     [],
     exclude_binaries=True,
-    name='BR-Equipment-Control',
+    name='br-equipment-control-app',
     debug=False,
     bootloader_ignore_signals=False,
     strip=False,
@@ -100,14 +100,14 @@ coll = COLLECT(
     strip=False,
     upx=True,
     upx_exclude=[],
-    name='BR-Equipment-Control',
+    name='br-equipment-control-app',
 )
 
 # macOS app bundle
 if sys.platform == 'darwin':
     app = BUNDLE(
         coll,
-        name='BR Equipment Control.app',
+        name='br-equipment-control-app.app',
         icon=None,  # Icon can be set manually later if needed
         bundle_identifier='com.bluerobotics.equipment-control',
         info_plist={