42 lines
1.3 KiB
Markdown
42 lines
1.3 KiB
Markdown
# Quick Task 260322-27k: Add project README - Context
|
|
|
|
**Gathered:** 2026-03-22
|
|
**Status:** Ready for planning
|
|
|
|
<domain>
|
|
## Task Boundary
|
|
|
|
Add a project README.md to the repository root with overview, features, installation, usage examples, and build requirements/how to build.
|
|
|
|
</domain>
|
|
|
|
<decisions>
|
|
## Implementation Decisions
|
|
|
|
### Content Depth
|
|
- Comprehensive sections: overview, features list, installation instructions, usage with CLI examples, build requirements and how-to-build guide
|
|
- No contributing guidelines or architecture section needed at this stage
|
|
|
|
### Platform Scope
|
|
- Linux only — focus on the primary eBPF-based experience
|
|
- No macOS installation or usage instructions
|
|
|
|
### Visual Elements
|
|
- No badges (no CI set up yet)
|
|
- Include a placeholder/section for an animated TUI screenshot
|
|
- Provide guidance on tools for creating animated terminal recordings (e.g., asciinema, VHS by Charmbracelet, ttygif)
|
|
|
|
### Claude's Discretion
|
|
- Exact section ordering and formatting style
|
|
- Level of detail in CLI usage examples
|
|
|
|
</decisions>
|
|
|
|
<specifics>
|
|
## Specific Ideas
|
|
|
|
- User wants advice on creating animated terminal screenshots/recordings for the README
|
|
- Build section should cover prerequisites (Rust nightly, bpf-linker, LLVM) and build commands
|
|
|
|
</specifics>
|