Skip to content

Suggest documentation improvement & dotnet tool install support for easier onboarding #49

@InCerryGit

Description

@InCerryGit

Feature/Improvement Suggestion

  1. Improve and extend the installation & configuration documentation

    • Add step-by-step installation guides for prebuilt binaries from the Release page, for all supported platforms (Windows, macOS, Linux)
    • Provide MCP client configuration examples for common tools (e.g. Claude Desktop, Cursor, VS Code)
    • Include troubleshooting/common issues section
  2. Support installation as a dotnet tool

    • Update .csproj to include <PackAsTool>true</PackAsTool>, <ToolCommandName>, etc.
    • Publish to NuGet for easy installation via dotnet tool install -g ...
    • This simplifies MCP client config (users can just use decompiler-server as command)

Background

The current README contains basic build & usage instructions, but onboarding is still not beginner-friendly: no single-step install, no per-client config, and little troubleshooting. Supporting installation via dotnet tool and providing more detailed docs would make it easier for more users (including those less familiar with .NET) to get started quickly.

Thank you for your awesome work on this project!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions