Skip to content

Rework the readme #2358

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

Draft
sharadhr wants to merge 39 commits into
base: main
Choose a base branch
from
+1,417 −1,125
Draft

Rework the readme #2358

Show file tree
Hide file tree
Changes from 25 commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
a2fdd46
Initial readme rework
sharadhr Nov 11, 2025
38f97ad
Adhere to some markdownlint recommendations
sharadhr Nov 11, 2025
2eeeffb
Introduction and installation
sharadhr Nov 23, 2025
581d2fe
Building section
sharadhr Nov 23, 2025
44e8b2e
Minor intro changes
sharadhr Dec 9, 2025
28da47d
Initial move of stuff into separate markdown files
sharadhr Dec 9, 2025
ff47f4d
Changed header levels
sharadhr Dec 9, 2025
48230db
WIP
sharadhr Dec 9, 2025
ea30728
Update `Usage.md` for structs
sharadhr Dec 14, 2025
576fd7a
Add one more line break for note
sharadhr Dec 14, 2025
8ebd4e1
Detail struct usage
sharadhr Jan 10, 2026
ef06932
Usage rework continues
sharadhr Jan 10, 2026
63baf67
Move handles dpcs to `Handles.md`
sharadhr Jan 10, 2026
293eca2
Add changes from `main`
sharadhr Jan 13, 2026
6814ae4
Rework error-handling section
sharadhr Jan 14, 2026
f226b87
Add note about CI status broken
sharadhr Jan 14, 2026
67cea09
Minor top-level updates
sharadhr Jan 14, 2026
13a596f
Move some things around in preparation
sharadhr Jan 15, 2026
babee1b
Minor wording
sharadhr Jan 15, 2026
bad7816
Move more things around and change header levels
sharadhr Jan 15, 2026
cd2966a
Add headings and TOC for Handles doc
sharadhr Jan 15, 2026
e069b48
Rewrite and reformat the dispatcher section
sharadhr Jan 16, 2026
099ec32
Update misc sections;
sharadhr Jan 16, 2026
36da1fb
Update last few sections
sharadhr Jan 16, 2026
f0ccf58
Big rewrite for C++ module section
sharadhr Jan 16, 2026
2e3ad61
Apply suggestions from @M2-TE
sharadhr Jan 20, 2026
9bc5ff7
Resolve comments for `Building.md`
sharadhr Jan 20, 2026
2a08fcc
Reword configuration intro
sharadhr Jan 20, 2026
b3667d3
More rework for suggestions; up to error-handling
sharadhr Jan 21, 2026
a2ff7a5
Suggestions to dynamic loader section implemented
sharadhr Jan 21, 2026
e01f41b
Newlines
sharadhr Jan 21, 2026
e59bf2f
Module suggestions by @M2-TE
sharadhr Jan 21, 2026
77aec21
Module changes
sharadhr Jan 21, 2026
efec79e
Apply module dyndis suggestion
sharadhr Jan 21, 2026
53a2d1a
Module doc updates
sharadhr Jan 21, 2026
4b8ff1b
Update extension inspection table
sharadhr Jan 21, 2026
8ce85d1
Initialise more stuff in module example
sharadhr Jan 21, 2026
f14be12
Minor change on module names
sharadhr Jan 21, 2026
3698b54
Write CLI compilation of Vulkan module
sharadhr Jan 30, 2026
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
Loading