Skip to content

Clean up root directory and refresh README#6

Merged
ekg merged 1 commit intomainfrom
cleanup-root-directory
Oct 20, 2025
Merged

Clean up root directory and refresh README#6
ekg merged 1 commit intomainfrom
cleanup-root-directory

Conversation

@ekg
Copy link
Copy Markdown
Contributor

@ekg ekg commented Oct 20, 2025

Summary

This PR cleans up the repository by removing 183 temporary/debug files from the root directory and completely refreshing the README to accurately reflect SeqRush's current functionality.

Changes

Root Directory Cleanup (183 files removed)

  • ✅ Removed temporary test data files (.fa, .fai, .paf, .odgi, .html, etc.)
  • ✅ Removed debug scripts and analysis tools (Python, shell scripts)
  • ✅ Removed development notes and historical documentation
  • ✅ Removed compiled artifacts and temp directories
  • ✅ Removed pafcheck submodule (no longer used)
  • ✅ Kept only essential files: source code, submodules, config files

Files remaining in root (12 essential files):

  • Source/config: Cargo.toml, Cargo.lock, rust-toolchain.toml, .gitignore, .gitmodules
  • Documentation: README.md, CLAUDE.md, LICENSE
  • Submodules: allwave/, WFA2-lib/, HLA-zoo/, seqwish-local/

README Complete Refresh

Old: "Prototype with Planned features"
New: Production tool with implemented features

Key updates:

  • ✅ Removed all "Planned" markers for completed features
  • ✅ Documented AllWave and SweepGA aligners (both implemented)
  • ✅ Documented bidirected union-find (implemented)
  • ✅ Documented iterative alignment with two-phase processing (implemented)
  • ✅ Added sparsification strategies documentation
  • ✅ Added validation results (HLA-Zoo: 100% structural correctness)
  • ✅ Updated project structure to match actual codebase
  • ✅ Corrected repository URL to pangenome organization
  • ✅ Updated acknowledgments to reflect actual dependencies

Verification

  • ✅ Build successful: cargo build --release --features use-allwave
  • ✅ All tests pass: cargo test (100% pass rate)
  • ✅ No code changes - only documentation and file cleanup

Impact

The repository now has a clean, professional presentation that accurately reflects SeqRush's actual capabilities. No functional changes.

This commit cleans up the repository by removing 183 temporary/debug files
from the root directory and completely refreshing the README to accurately
reflect SeqRush's current functionality.

Changes:

Root Directory Cleanup:
- Removed temporary test data files (.fa, .fai, .paf, .odgi, .html, etc.)
- Removed debug scripts and analysis tools (Python, shell scripts)
- Removed development notes and historical documentation
- Removed compiled artifacts and temp directories
- Removed pafcheck submodule (no longer used)
- Kept only essential files: source code, submodules, config files

README Refresh:
- Updated description to reflect actual implemented features
- Removed "Planned" markers for completed features:
  * AllWave and SweepGA aligners (implemented)
  * Bidirected union-find (implemented)
  * Graph layout pipeline (implemented)
  * Iterative alignment (implemented)
- Added comprehensive usage examples for all features
- Documented iterative alignment with two-phase processing
- Added sparsification strategies documentation
- Included validation results from HLA-Zoo testing
- Updated project structure to match actual codebase
- Corrected repository URL to pangenome organization
- Updated acknowledgments to reflect actual dependencies

The repository now presents a clean, professional interface that accurately
documents the tool's capabilities.

All tests pass. Build verified.
@ekg ekg merged commit c17f287 into main Oct 20, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant