docs: add branding, update docs and license#39
Open
ReenigneArcher wants to merge 7 commits into
Open
Conversation
Move extensive README content into separate documentation pages organized by topic: usage and CMake consumption, platform support details, Windows driver package guide, streaming-host integration requirements, and development workflow. Update Doxygen configuration to include all new pages. This makes documentation more maintainable and easier to navigate while keeping README concise with links to detailed topics.
Update `docs/windows-driver.md` with Microsoft Store listing guidance for the Windows driver package, including ready-to-use short and full description text. The new section clarifies that the Store surface is the user-mode driver component (not the C++ library) and notes that it has no standalone UI.
Introduce a new LICENSES map and add the LizardByte Source-Available License 1.0 for Windows UMDF driver code and packaged driver artifacts. Update README and Windows driver docs to reflect the split licensing model, include the license map in Doxygen inputs, and adjust Windows CPack/WiX packaging to ship both MIT and SAL license files while using the SAL text as the installer license resource.
Introduce a new README “Alternatives” section with a feature matrix comparing libvirtualhid against ViGEmBus, HIDMaestro, inputtino, and WinUHid. The update adds detailed footnotes to clarify platform/API scope, descriptor behavior, and Windows ARM64 packaging/signing constraints so readers can evaluate tradeoffs more accurately.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #39 +/- ##
==========================================
+ Coverage 87.81% 89.77% +1.96%
==========================================
Files 14 14
Lines 4235 4500 +265
Branches 1436 1512 +76
==========================================
+ Hits 3719 4040 +321
+ Misses 357 343 -14
+ Partials 159 117 -42
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report in Codecov by Harness.
|
Replace file(COPY_FILE) with configure_file() and COPYONLY option. This provides better CMake compatibility and is the more idiomatic approach for copying files during the build configuration phase.
ReenigneArcher
force-pushed
the
chore/branding
branch
from
398a2f2 to
29d3455
Compare
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds branding images, needed to submit to Microsoft Store (though not sure if they will accept this). Also updates docs and licensing.
Screenshot
Issues Fixed or Closed
Roadmap Issues
Type of Change
Checklist
AI Usage