What this is
The current README assumes prior context. A first-time contributor — researcher, developer, or clinician — should be able to read the top 1–2 paragraphs and know whether the project is for them, what state it's in, and where to go next.
This issue: rewrite the top section of the README (above the technical-setup material) so it answers four questions:
- What is Open-LIFU? (Plain language. Two sentences.)
- Who is this for? (One sentence per audience: developers, researchers, clinicians.)
- What state is the project in? (Honest about the MATLAB→Python migration, the research-only regulatory status, the active contributor count.)
- Where do I go next? (Three links: community hub, Discord, this repo's good-first-issues filter.)
Why this matters
The README is the front door of the technical project. Right now it skips the "is this for me?" filter, which means people who shouldn't bother bounce in confusion and people who would be great contributors bounce because they can't tell.
What to do
- Comment to claim.
- Read the existing README top to bottom.
- Read the linked context: our community hub, the Frontiers paper, the latest 2–3 commits to get a sense of project state.
- Rewrite the top section (above existing setup material) addressing the four questions above. Keep it short — 4–6 short paragraphs total.
- Preserve the existing technical-setup material below your new top section unchanged.
- Include the short-form FDA disclaimer.
- Submit as a PR.
Definition of done
Skills
- Technical writing
- Willingness to be opinionated about what a new contributor needs to read first
Scope estimate
3–5 hours.
Helpful starting points
How to claim this issue
- Comment "I'd like to work on this" — we'll assign it to you.
- Open a draft PR within ~2 weeks of being assigned.
- Ask any setup questions on this issue or in our Discord
#contributing channel.
Contact: community@openwater.health
By contributing, you agree to our Contributor License Agreement. (If the CLA isn't yet live when you start, we'll handle it once the flow is up.)
What this is
The current README assumes prior context. A first-time contributor — researcher, developer, or clinician — should be able to read the top 1–2 paragraphs and know whether the project is for them, what state it's in, and where to go next.
This issue: rewrite the top section of the README (above the technical-setup material) so it answers four questions:
Why this matters
The README is the front door of the technical project. Right now it skips the "is this for me?" filter, which means people who shouldn't bother bounce in confusion and people who would be great contributors bounce because they can't tell.
What to do
Definition of done
Skills
Scope estimate
3–5 hours.
Helpful starting points
README.md: https://github.com/OpenwaterHealth/opw_neuromod_swHow to claim this issue
#contributingchannel.Contact: community@openwater.health
By contributing, you agree to our Contributor License Agreement. (If the CLA isn't yet live when you start, we'll handle it once the flow is up.)