How adityachandak287/aoc-2024 works
Main Components
a) Solution Structure Layer
• Day's solution as a separate module
• Language separation (Python vs. Go solutions)
• Input handling components
b) Common Patterns Layer
• Input file processors
• Test case handlers (sample files)
• Part A/B solution splits
Top Level:
┌─────────────────────────────────────────┐
• AOC 2024 Solutions │
• ┘
• ↙ ↘
┌─────────────┐ ┌─────────────┐
• Python │ │ Go │
• Solutions │ │ Solutions │
• ┘ └─────────────┘
Component Representation
• Rounded rectangles for solution files
• Hexagons for input/sample files
Detailed Structure
For each day's solution, show:
┌─────────── Day XX ───────────┐
• ┌─────────┐ ┌─────────┐ │
• Part A │ │ Part B │ │
• ┘ └─────────┘ │
• ↓ ↓ │
• ┌─────────────────┐ │
• Input Handler │ │
• ┘ │
• ↙ ↘ │
• ┌─────────┐ ┌─────────┐ │
• Input │ │ Sample │ │
• ┘ └─────────┘ │
• ┘
┌─────── Day 06 ─────┐
• ┌─────────┐ │
• main.go │ │
• ┬────┘ │
• ↓ │
• ┌───────────────┐ │
• solution package│ │
• ┘ │
• ┘
Additional Elements
• A version/language indicator (Go modules from go.mod)
• Separation between different days clearly
• Dual-part nature of AOC problems (Part A/B)
Implementation Notes
• Maintain consistent spacing and alignment
• Use clear, readable fonts and appropriate sizing
• The modular nature of daily solutions
• The multi-language approach
• The consistent pattern of input handling
• The separation between solution logic and input processing
• The relationship between sample files and solution files
This structure will help other developers understand the organization and flow of the AOC solutions while maintaining clarity about the different implementation approaches used across days.