chartify icon indicating copy to clipboard operation
chartify copied to clipboard

Add comprehensive build instructions and usage documentation

Open Copilot opened this issue 4 months ago • 0 comments

This PR addresses the confusion around building and using the chartify tool by adding comprehensive build targets and documentation that were missing from the repository.

Changes Made

Makefile Enhancements

Added essential build targets that were requested:

  • make build - builds both chartify and chartreposerver binaries
  • make clean - removes built binaries
  • make install - installs binaries to $GOPATH/bin
  • make all - default target that builds everything
  • Individual targets build-chartify and build-chartreposerver for granular control

README Documentation

Significantly expanded the README with:

  • Prerequisites section - specifies Go 1.24.0+ and Helm 3.x requirements
  • Building and Installation section - clear instructions for both local builds and Go install
  • Enhanced CLI documentation - detailed examples and usage for both tools:
    • chartify examples with various flags and use cases
    • chartreposerver usage instructions
    • Complete help output documentation
  • Development section - information about testing and linting

Repository Maintenance

  • Added built binaries (chartify, chartreposerver) to .gitignore to prevent accidental commits
  • All changes are backwards compatible and don't affect existing functionality

Before/After Comparison

Before: Users were confused about how to build and run the tool, with no build section in Makefile and minimal usage instructions.

After: Users can now easily:

# Build the project
make build

# Get help
./chartify -h
./chartreposerver

# Clean up
make clean

# Install system-wide
make install

The documentation now provides clear examples for common use cases like converting charts with dependencies, including CRDs, and applying patches.

Fixes #65.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot avatar Sep 09 '25 23:09 Copilot