# Submit a project

Anyone who maintains an open-source kext, patch, porting tool or driver documentation for macOS on non-Apple hardware can list it. You add one file to the [registry](https://github.com/openkext/registry) with a pull request, and a bot checks it against fixed rules. If every rule passes, it merges without waiting for a person.

## Before you start

- The project is open source under a license on the [automatic list](governance.md#licenses). Other OSI-approved licenses are fine after a maintainer looks at them.
- The source is a public GitHub repository.
- There is at least one published GitHub release, and you know the SHA-256 of each asset you want to list (`shasum -a 256 FILE`).
- Your GitHub account is at least 30 days old.
- The project ships no Apple software and doesn't help anyone get around activation or licensing. See the [legal boundaries](driver-development.md#legal-boundaries) in the driver guide.

## Steps

1. Fork [openkext/registry](https://github.com/openkext/registry).
2. Create `kexts/<id>/kext.toml`, where `<id>` is a short name in lowercase letters, digits and dashes. Copy the example below and fill it in. Put your own GitHub login in `maintainers`.
3. Run the checks locally if you like: `python3 tools/check_registry.py` (Python 3.11 or newer, no dependencies).
4. Optional: add your own test report in the same pull request. See [Report a test](report.md).
5. Open the pull request. The bot answers within a couple of minutes, either with an approval, with the rule that failed, or with a note that a maintainer will review it.

Write `ai_disclosure` honestly. "none" is fine if you didn't use AI tools; otherwise name the tools and models. It is shown on the project page so users can judge for themselves.

## Updating your entry

To add a release or change the description, edit `kexts/<id>/kext.toml` in a new pull request. Published releases can't be edited or removed by the bot; add a new release instead. Changing `id`, `source`, `license` or `maintainers` goes to a maintainer. The full list is in the [governance rules](governance.md).

## kext.toml

One file per project: `kexts/<id>/kext.toml`. TOML, UTF-8, under 64 KB.

```toml
id = "demo-wifi"                 # lowercase letters, digits and dashes; same as the folder
name = "Demo Wi-Fi"
summary = "One or two sentences, up to 280 characters."
kind = "kext"                    # kext | patch | tool | docs
categories = ["wifi"]            # wifi bluetooth audio graphics ethernet usb storage input power sensors cpu firmware other
source = "https://github.com/you/demo-wifi"
license = "GPL-2.0-only"         # SPDX id, see GOVERNANCE.md
license_file = "LICENSE"         # optional: path of the license text in the repository
maintainers = ["you"]            # GitHub logins
ai_disclosure = "none"           # or the AI tools and models used, e.g. "Claude Opus 5.5"
homepage = "https://..."         # optional
based_on = ["https://github.com/OpenIntelWireless/itlwm"]   # optional: upstream projects

[[hardware]]                     # optional, repeatable
vendor = "intel"
description = "Intel Wi-Fi 6E AX210"
pci_ids = ["8086:2725"]          # lowercase vvvv:dddd; usb_ids works the same way

[macos]                          # range you tested
min = "15.8"
max = "26.7"

[[releases]]                     # oldest first; repeat for each release
version = "1.0.0"
tag = "v1.0.0"                   # the GitHub release tag
date = 2026-11-15
notes = "Optional, up to 500 characters."

  [[releases.assets]]
  name = "DemoWiFi-1.0.0.zip"    # exact asset name in the GitHub release
  sha256 = "64 lowercase hex characters"
  macos = "26"                   # optional: which macOS this asset is for
```

Get the hash with `shasum -a 256 DemoWiFi-1.0.0.zip`.

Source: https://github.com/openkext/openkext.github.io/blob/main/content/submit.md
