Improve documentation

[LCrossman]

Is your feature request related to a problem? Please describe.
More, clear documentation with more examples, set up separate docs for better clarity

Describe the solution you'd like

Add steps for installation for people who haven't used Rust
Add links to additional documentation or guidelines

Additional context
Add any other context or screenshots about the feature request here.

[ZEZE1020]

Revamp README to reflect actual project structure

labels: layout, organization

assignees: @ZEZE1020

Description

Change Type:

• File Structure Update(README.md)
• Refactoring
• Modularization
• Other (Please specify):

Current Structure:
The root directory contains:

.github/  
docs/  
heatmap/  
microBioRust/  
microbiorust-py/  
seqmetrics/  
.gitignore  
Cargo.toml  
LICENSE
mkdocs.yml  
README.md  
ROADMAP.md    

The existing README.md is a single long document without badges, workspace overview, or a navigable table of contents.

Proposed Changes:

• Add relevant project status badges (crates.io for each Rust crate, docs site, CI build) at the top.
• Introduce a one-sentence project overview.
• Insert a clickable Table of Contents linking to: Features, Prerequisites, Installation, Quickstart, Workspaces Overview, Contributing, Roadmap, License.
• Add a Workspaces section listing and linking to each directory (microSeqIO, heatmap, microbiorust-py, seqmetrics, doc).
• Restructure README into clear sections (as above) for easier scanning.

Motivation

A concise, badge-driven README with clear navigation helps both new users and contributors quickly find the information they need, reducing onboarding friction.

Potential Impact

• Update internal anchor links in the README.
• Validate badge URLs (docs site, crates.io pages).
• Minimal risk—documentation only.

Additional Context

Refer to the current directory listing above. Once the template is in place, subsequent issues can tackle CONTRIBUTING.md, EXAMPLES.md, CHANGELOG.md etc.