Summary
The current README is a minimal 70-line placeholder. This issue tracks replacing it with a production-quality document covering:
- All CLI options with defaults verified against the implementation
- Execution flow (disk sweep, job calculation, test matrix)
- Output directory layout and CSV schema
- Regression mode, etcd simulation, LVM mode, filesystem-backed files
- PCP integration
- Troubleshooting and known limitations
- Dependencies per OS (RHEL, Ubuntu, Amazon Linux)
Modeled after the autohpl-wrapper README for consistency across the Red Hat Performance wrapper family.
Related: #66 (etcd_opts code bugs documented as known limitations in the new README)
Summary
The current README is a minimal 70-line placeholder. This issue tracks replacing it with a production-quality document covering:
Modeled after the autohpl-wrapper README for consistency across the Red Hat Performance wrapper family.
Related: #66 (etcd_opts code bugs documented as known limitations in the new README)