<h1 align="center">Widget Porting Toolkit</h1>

<p align="center">
  <img src="https://img.shields.io/badge/Swift-F05138?logo=swift&logoColor=white" />
  <img src="https://github.com/nikolan123/WidgetPortingToolkit/actions/workflows/nightlybuild.yaml/badge.svg" />
  <img src="https://img.shields.io/badge/platform-macOS-blue" />
  <img src="https://img.shields.io/github/last-commit/nikolan123/WidgetPortingToolkit" />
</p>

<p align="center">
  Allows you to run Dashboard widgets (OS X 10.4 - 10.14) on new macOS versions (12.0+).
</p>

<img align="center" alt="Screenshot" src=".github/assets/readme_screenshot.webp">

<p align="center">
  <a href="https://github.com/nikolan123/WidgetPortingToolkit/releases/download/nightly/Widget.Porting.Toolkit.dmg">
    <img height="50" alt="Download Button" src=".github/assets/download_button.png" />
  </a>
  <br>
  macOS 12.0 or later<a href="./.github/OTHEROS.md">*</a>. Intel & Apple Silicon. Nightly build
</p>

<p align="center">
  <a href="https://widgets.nikolan.net">Project Website</a>
  •
  <a href="https://widgets.nikolan.net/qsg.html">Quick Start Guide</a>
  •
  <a href="https://blog.nikolan.net/posts/dashboard-widgets/">Blog Post</a>
</p>

<p align="center">This is a side project made in my free time to learn Swift. Parts of the code are messy. Contributions always welcome.</p>

## Getting Started

1. Download the latest DMG from the button above or from the [releases page](https://github.com/nikolan123/WidgetPortingToolkit/releases)
2. Open the DMG and move Widget Porting Toolkit to your Applications folder
3. Launch the app
4. Drag `.wdgt` bundles into the app

## Building From Source

Building from source is only needed if you want to modify the app or contribute code.

```bash
git clone https://github.com/nikolan123/WidgetPortingToolkit.git
cd WidgetPortingToolkit
open WidgetPortingAPP.xcodeproj
```

1. Build and run in Xcode
2. Use the menu to install the Support Directory
3. Drag `.wdgt` bundles into the app

## Resources

[Dashboard Reference](https://adc09.nikolan.net/documentation/AppleApplications/Reference/Dashboard_Ref/DashboardRef/DashboardRef.html)

[Dashboard Programming Topics](https://adc09.nikolan.net/documentation/AppleApplications/Conceptual/Dashboard_ProgTopics/Introduction/Introduction.html)

[Kludgets](https://github.com/icedman/kludgets)
