Skip to content

Clarify README: what bld does, why it matters, and how it works#17

Draft
Copilot wants to merge 3 commits intomainfrom
copilot/update-readme-for-clarity
Draft

Clarify README: what bld does, why it matters, and how it works#17
Copilot wants to merge 3 commits intomainfrom
copilot/update-readme-for-clarity

Conversation

Copy link
Contributor

Copilot AI commented Dec 11, 2025

The README was terse and unclear about bld’s purpose, impact, and operation. This update explains what the tool does, why it’s useful, and how it works, with pragmatic, lighthearted scenarios.

  • Overview refresh
    • Describes bld as a .NET/msbuild Swiss Army knife
    • Outlines capabilities (clean, NuGet/TFM management, CPM, outdated, container scan)
  • Value and approach
    • Highlights why it matters (disk savings, alignment, audits)
    • Summarizes how it works (MSBuild eval, dry-run defaults, conflict surfacing)
  • Sample scenarios
    • Adds concise, ready-to-run examples for cleaning, dependency inventory, and TFM alignment

Example snippet:

# Nuke build bloat, safely
bld clean --root C:\src\MyRepo --depth 4 --obj

# Get a bird’s-eye view of dependencies
bld nuget --root . --aggregate --show-projects

# Align TFMs for modern SDKs
bld tfm --root MySolution.sln --to net9.0 --apply
Original prompt

the readme of this repo needs to make it much clearer a) what the tool does b) why that is important and helpful c) how it does it.
Add more samples and scenatios and insight and be a little ... not brash but ... also not really in your face but a bit lighthearted, cool, pragmatic


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits December 11, 2025 12:42
Co-authored-by: dlosch <318550+dlosch@users.noreply.github.com>
Co-authored-by: dlosch <318550+dlosch@users.noreply.github.com>
Copilot AI changed the title [WIP] Enhance README with clearer descriptions and examples Clarify README: what bld does, why it matters, and how it works Dec 11, 2025
Copilot AI requested a review from dlosch December 11, 2025 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants