Skip to content

Add comprehensive README.md documentation#2

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/add-comprehensive-readme
Draft

Add comprehensive README.md documentation#2
Copilot wants to merge 2 commits intomainfrom
copilot/add-comprehensive-readme

Conversation

Copy link

Copilot AI commented Dec 1, 2025

Adds project documentation covering usage, installation, and structure as requested.

Changes

  • Installation: Core requirements (Python 3.8+, NumPy) and optional acceleration deps (pydivsufsort, numba, Cython)
  • CLI usage: Full argument reference with examples
  • Output formats: BED, VCF, TRF, STRfinder column specs
  • Detection tiers: Tier 1 (1-9bp perfect), Tier 2 (≥10bp imperfect), Tier 3 (100bp+ long-read)
  • Project structure: Directory layout with module descriptions; mentions results/ test sequences without detail per spec

Example usage from README

# Basic
python -m src.main genome.fa

# With options
python -m src.main genome.fa --min-period 2 --max-period 50 --tiers tier1 --format vcf -v
Original prompt

On /, Write a comprehensive README.md file for this project. All you need to detail is how to use this tool, and how this tool is structured (mention, but do not detail, the test seqs).


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: framazan <93796158+framazan@users.noreply.github.com>
Copilot AI changed the title [WIP] Add comprehensive README.md file for project Add comprehensive README.md documentation Dec 1, 2025
Copilot AI requested a review from framazan December 1, 2025 02:41
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.

2 participants