Skip to content

Build from source

  • macOS 14 or later
  • Xcode command-line tools with Swift 5.10 or later
  • Node.js 24 only when working on this documentation site
  1. Clone the repository

    Terminal window
    git clone https://github.com/vmg-dev/floodlight.git
    cd floodlight
  2. Build and test

    Terminal window
    make test
  3. Create the application bundle

    Terminal window
    make bundle
    open .build/Floodlight.app
  4. Create a local DMG

    Terminal window
    make dmg

Sources/Floodlight/Resources/AppIcon.png is the 1024-pixel application icon master used by Finder and the DMG installation flow. Run make icons to generate .build/Floodlight.icns; make bundle does this automatically.

The menu bar intentionally uses a separate 18-point black-and-clear vector: Sources/Floodlight/Resources/FloodlightMenuBar.svg. Floodlight marks it as an AppKit template image so macOS applies the correct light, dark, highlighted, and accessibility treatment instead of shrinking the full-color application icon.

cd docs
npm install
npm run dev

Run npm run build before submitting documentation changes. Astro emits the static site under docs/dist.