docs: move CREDITS.md and FIRMWARE.md under docs/

Neither gets special root treatment from GitHub (only README/LICENSE/
CONTRIBUTING do), so they belong with the rest of the docs. Repoint README,
CONTRIBUTING, and METHODOLOGY.md at the new paths.
This commit is contained in:
derv82
2026-08-02 03:57:45 -07:00
parent 8725b29af0
commit fe900c3e49
5 changed files with 7 additions and 7 deletions
+2 -2
View File
@@ -42,7 +42,7 @@ milestone against the cold-boot pcap, and ship the chip's `<CHIP>.md` reference.
[`docs/porting/CHIP-DOC.md`](docs/porting/CHIP-DOC.md).
Your PR should include the `<CHIP>.md` reference, evidence it works (at minimum the offline pcap
verification), and credits for the upstream driver's authors in CREDITS.md.
verification), and credits for the upstream driver's authors in docs/CREDITS.md.
## Commits & pull requests
@@ -58,5 +58,5 @@ verification), and credits for the upstream driver's authors in CREDITS.md.
By submitting a PR you agree your contribution is licensed under **GPL-2.0-only** (wifit3 is a
derivative of GPLv2 kernel/vendor drivers, not optional), and that you have the right to
contribute it. Any firmware blob under `chips/<chip>/assets/` is not GPL: record its provenance
and redistribution terms (see [FIRMWARE.md](FIRMWARE.md)) and byte-verify it against
and redistribution terms (see [FIRMWARE.md](docs/FIRMWARE.md)) and byte-verify it against
linux-firmware.
+3 -3
View File
@@ -111,7 +111,7 @@ A few more of the driver authors we ported from:
- **Sujith Manoharan** and the **ath9k** team; **Bitterblue Smith** and the Realtek **rtw88** team.
The full list (every substantive contributor to the drivers we ported, and the cards they
enabled) is in **[CREDITS.md](CREDITS.md)**.
enabled) is in **[CREDITS.md](docs/CREDITS.md)**.
## Mini-Drivers
@@ -159,7 +159,7 @@ The loop in brief:
Wifit3 is licensed under the **GNU General Public License v2.0** (GPL-2.0-only): see
[LICENSE](LICENSE). The userland drivers are ports of GPLv2 Linux kernel and vendor DKMS
drivers, so GPLv2 is the natural fit; the upstream authors are credited in [CREDITS.md](CREDITS.md).
drivers, so GPLv2 is the natural fit; the upstream authors are credited in [CREDITS.md](docs/CREDITS.md).
**Source for binary releases.** The prebuilt executables on the Releases page are built from
this repository. The complete corresponding source for any released binary is this repository
@@ -169,7 +169,7 @@ binary is offered.
**Firmware is not GPL.** The vendor firmware blobs that Wifit3 loads onto the cards are
redistributed verbatim under their own manufacturers' licenses (Realtek / MediaTek / Ralink),
*not* the GPL. Each ships with its license text alongside it; provenance and byte-verification
are documented in [FIRMWARE.md](FIRMWARE.md).
are documented in [FIRMWARE.md](docs/FIRMWARE.md).
## Disclaimer
View File
View File
+2 -2
View File
@@ -203,13 +203,13 @@ the reference AP first, and flip the default only once the new port ties or beat
## Housekeeping — every new port
- **Credits** — add the upstream driver's substantive contributors to CREDITS.md, mapped to the
- **Credits** — add the upstream driver's substantive contributors to docs/CREDITS.md, mapped to the
new card. Tally commit authorship of the kernel path (and the vendor repo); beware kernel file
renames (GitHub's `?path=` filter doesn't follow them, so scrape the pre-reorg path too). Drop
tree-wide mechanical committers; keep the real builders.
- **Licensing** — wifit3 is GPL-2.0-only (a derivative of GPLv2 drivers). Any firmware blob in
`chips/<chip>/assets/` is not GPL: record its provenance + redistribution terms from
linux-firmware's WHENCE and byte-verify the blob (see FIRMWARE.md).
linux-firmware's WHENCE and byte-verify the blob (see docs/FIRMWARE.md).
## Terms