docs: mention Bear for generating compile_commands.json for assembly projects#296
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the README to document how to generate a compile_commands.json for assembly projects, complementing the existing section that describes how asm-lsp consumes compilation databases for hover and diagnostics.
Changes:
- Add a short README note pointing users to Bear as a way to generate
compile_commands.jsonduring an assembly build. - Explain (briefly) that Bear can capture include directories and defines for supported assemblers.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
WillLillis
approved these changes
Jul 8, 2026
WillLillis
force-pushed
the
docs-mention-bear
branch
from
bb088cd to
934a617
Compare
The "Extend functionality" section explained how asm-lsp consumes a compile_commands.json but not how to produce one for an assembly project. Bear recognizes nasm/yasm/fasm and records the include dirs and defines asm-lsp reads, so add a one-line pointer. Closes #295. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
WillLillis
force-pushed
the
docs-mention-bear
branch
from
934a617 to
3d63c80
Compare
Collaborator
|
Thanks! |
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
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.
Follow-up to #295 (thanks for the quick go-ahead, @WillLillis).
The "Extend functionality via `compile_commands.json`/`compile_flags.txt`" section describes how asm-lsp consumes a compilation database, but not how to produce one for an assembly project. This adds a short pointer to Bear, which recognizes the
nasm,yasm, andfasmassemblers and records each file's include directories and defines -- the same information asm-lsp reads for hover and diagnostics.One-paragraph docs change only; no version number is hard-coded in the text.
Closes #295.