docs: rewrite README as Qt/QML VS Code config demo (+ qmlls settings)#7
Merged
Conversation
Replace the leftover upstream Notes README with documentation for this repository as a VS Code configuration demo for Qt6 + QML development. The new README focuses on .vscode/settings.json, explaining every key group by group: disabling the MS C/C++ IntelliSense engine in favor of clangd, CMake Presets, editor/formatting options, file associations, search excludes, and especially the QML Language Server (qmlls) settings and how they relate to the build-generated .qmlls.ini. It also documents extensions.json, launch.json and tasks.json. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
What
This PR brings two things onto
main:maindiff —Add QML Language Server settings to VSCode configuration(1daa218), which was on localmainbut not yet on the remote. It adds the qmlls (QML Language Server) configuration to.vscode/settings.json.README.mdwas a leftover copy of the upstream Notes app and didn't describe this repository at all.README rewrite
The new
README.mdintroduces this repo as a Qt / QML VS Code configuration demo and documents.vscode/settings.jsonkey by key:C_Cpp.intelliSenseEngine: disabledto hand IntelliSense to clangd, plus the clangd formatter setup.cmake.useCMakePresets: always..h/.hpp/.inl→ C++ associations, trim trailing whitespace, final newline.build,.cache,node_modules,*_autogen.qt-qml.qmlls.*key explained (customExePath,additionalImportPaths,customArgs-b/-d,useNoCMakeCalls, tracing), and how they mirror the build-generated.qmlls.iniproduced bycmake/sync_qmlls_ini.cmake.It also documents
extensions.json,launch.json, andtasks.json, plus a quick-start and FAQ.Notes
settings.jsonqmlls additions — the rewrite touches documentation only.settings.jsonare called out in the README as machine-specific and meant to be adjusted by the reader.🤖 Generated with Claude Code