Add comprehensive build instructions and usage documentation #149
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.
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 bothchartify
andchartreposerver
binariesmake clean
- removes built binariesmake install
- installs binaries to$GOPATH/bin
make all
- default target that builds everythingbuild-chartify
andbuild-chartreposerver
for granular controlREADME Documentation
Significantly expanded the README with:
chartify
examples with various flags and use caseschartreposerver
usage instructionsRepository Maintenance
chartify
,chartreposerver
) to.gitignore
to prevent accidental commitsBefore/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:
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.