pantheon-ai/makefile-toolkit
Complete makefile toolkit with generation and validation capabilities
97
Quality
97%
Does it follow best practices?
Impact
Pending
No eval scenarios have been run
Securityby
Advisory
Suggest reviewing before use
README.mdgenerator/references/
Makefile Generator Reference Documentation
This directory contains comprehensive reference guides for generating production-ready Makefiles.
Quick Navigation
- Makefile Structure - File organization, layout, includes
- Variables Guide - Assignment operators, automatic variables, scope
- Targets Guide - Standard targets, .PHONY declarations, prerequisites
- Patterns Guide - Pattern rules, language-specific build patterns
- Optimization Guide - Parallel builds, caching, ccache integration
- Security Guide - Safe variable expansion, credential handling
Reading Order
For New Makefiles
- Start with Makefile Structure to understand file organization
- Read Variables Guide for variable assignment and scope
- Review Targets Guide for standard GNU targets
- Check Patterns Guide for your language (C/C++, Go, Python, Java)
For Production Makefiles
- Read Optimization Guide for performance improvements
- Review Security Guide for credential handling and safe practices
Common Lookup Tasks
| Task | Reference |
|---|---|
| Docker integration | Patterns Guide § Pattern 8 |
| Multi-binary projects | Patterns Guide § Pattern 7 |
| Go with version embedding | Patterns Guide § Pattern 5 |
| Parallel builds, ccache | Optimization Guide |
| Credentials, secrets | Security Guide |
| Complex dependencies | Patterns Guide |
| Order-only prerequisites | Optimization Guide or Targets Guide |
| Variable operators (?=, :=, +=) | Variables Guide |
Usage During Generation
When generating Makefiles, ALWAYS use the Read tool to consult relevant references before writing Makefile content. This ensures patterns are current and correctly applied.
Example workflow:
1. Read references/patterns-guide.md (find your language pattern)
2. Read references/security-guide.md (for Docker/deploy targets)
3. Generate Makefile combining patterns
4. Document which references were consulted in Makefile header