Docs: ASCII diagrams for the three things that are easy to get wrong Each of these cost real debugging time this week, and each is a geometry problem that prose describes badly: - How a breakpoint is matched to a feature. STAR reports the neighbouring INTRON base, not the aligned segment edge, and the offset mirrors on the minus strand. Also states plainly that breakpoint_tolerance is for annotation slack, not for absorbing coordinate error. - chimera_type geometry. te_initiated / te_exonized / te_terminated read off the TE's position along the direction of transcription, so the labels swap on a minus-strand gene. - The TE annotation hierarchy (class > family > subfamily > insertion) and which GTF attribute holds each, with a before/after of what keying te.bed by subfamily instead of insertion actually does to the intervals. TElocal gets a companion diagram contrasting the pooled TEcount row with the per-copy TElocal rows, and says which chimera column joins to which.
Add full documentation: config reference, CLI, HPC/SLURM, TElocal, chimera detection, output layout Moved out of the main repo's README, which was trimmed to a short landing page (install + quick start + links here).