add note that code to steane ftsp paper can be found on branch

[inctechs]

Description

Checklist:

• The pull request only contains commits that are focused and relevant to this change.
• The changes follow the project's style guidelines and introduce no new warnings.
• The changes are fully tested and pass the CI checks.
• I have reviewed my own code changes.

[coderabbitai]

📝 Walkthrough

Walkthrough

A documentation block was added to README.md highlighting a new branch (ft-stateprep-qubit-perm) for work on fault-tolerant state preparation circuits using Steane-type error detection, including a note that documentation is a work in progress.

Changes

Cohort / File(s)	Summary
Documentation update README.md	Added 4 lines documenting the ft-stateprep-qubit-perm branch with its project focus and WIP status note

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• updated readme with note for cococo #578: Updates README.md with branch-specific documentation notes for different project branches

Suggested reviewers

• pehamTom

Poem

🐰 A note in the README, so neat and so fine,
Documents branches where quantum qubits align,
State prep circuits with Steane's design,
Work in progress—the future will shine! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is largely incomplete and missing most required sections from the template.	Add a summary of changes, mention which issue (if any) is fixed, explain motivation/context, and ensure checklist items are properly addressed. Include documentation updates and changelog entries where applicable.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: adding a note about where code related to the Steane FTSP paper can be found (on a specific branch).
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@README.md`:
- Line 45: Remove the stray blank line inside the NOTE block in README.md that
triggers MD028 (no-blanks-blockquote); edit the NOTE block (the blockquote
beginning with "NOTE") and delete the empty line so the blockquote lines are
contiguous with no intervening blank line.