Skip to content

docs: OSS README standardization #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MattJackson merged 1 commit into from
Sep 6, 2026
Merged

docs: OSS README standardization #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# libapplegfx-vulkan

[![CI](https://github.com/MattJackson/libapplegfx-vulkan/actions/workflows/ci.yml/badge.svg)](https://github.com/MattJackson/libapplegfx-vulkan/actions/workflows/ci.yml)
[![Release](https://img.shields.io/github/v/release/MattJackson/libapplegfx-vulkan?display_name=tag&sort=semver)](https://github.com/MattJackson/libapplegfx-vulkan/releases)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

**Linux clean-room reimplementation of Apple's
`ParavirtualizedGraphics.framework` host-side library, with a
Vulkan rendering backend.** The host counterpart to the
Expand Down Expand Up @@ -283,6 +287,14 @@ meson setup build && meson install -C build
cc app.c $(pkg-config --cflags --libs libapplegfx-vulkan)
```

## Contributing

Contributions are welcome. See **[CONTRIBUTING.md](CONTRIBUTING.md)** for
how to build, test, and submit patches, and
**[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)** for the standards we hold each
other to. CI (fmt/build/tests as configured) runs on every push and pull
request, so please build and run the tests locally before opening a PR.

## License

**[MIT](LICENSE).** The whole tree — including the clean-room
Expand All @@ -294,6 +306,9 @@ copyright holder.)

- **Security:** [SECURITY.md](SECURITY.md) — privately via GitHub
Security Advisories or `matthew@pq.io`.
- **Private vulnerability reports:** please report security
vulnerabilities privately as described in [SECURITY.md](SECURITY.md)
rather than in public issues.
- **Bugs / patches:** see [CONTRIBUTING.md](CONTRIBUTING.md).
- **Code of conduct:** [CODE\_OF\_CONDUCT.md](CODE_OF_CONDUCT.md).

Expand All @@ -319,3 +334,8 @@ macOS Metal on Linux, QEMU apple-gfx-pci, paravirt GPU Linux,
AppleParavirtGPU kext, PVG Linux implementation,
`MTLCopyAllDevices` under QEMU, Metal over Vulkan, lavapipe Metal,
AIR to SPIR-V.

## Changelog

Release history and notable changes are tracked in
[CHANGELOG.md](CHANGELOG.md).
Loading