Paper Abstract
` with blank lines around two Markdown paragraphs, where method components (**HairPort**, **Bald Converter**, **Baldy**, **3D-aware Transfer Pipeline**) are bold. Collapsed by default, it renders as a single "▸ Paper Abstract" line.
**Status blockquote.** `> **Official source preview.** ...` followed by `>` and a second paragraph with inline code, rendered with GitHub's grey left bar and muted text.
**Numbered steps.** Installation and Quick Start use h3 headings with the number in the text (`### 1. Create an environment`), each followed by one sentence and one fenced block. Language tags are `bash`, `csv`, `text` and `python`; comments inside `bash` blocks label alternatives ("# Resume from a stage").
**Stage table.** `| # | Stage | What happens |` with `|---|-------|--------------|` delimiters and no alignment colons; the stage name is bold and the description is one sentence that may contain inline code.
**Dependency table.** `| Module | Repository | Used for |` with `owner/name` link text in the middle column.
**Citation.** "If you use HairPort in your research, please cite:" then a plain line of publication details (dates, place, DOI link, ISBN in inline code, preprint link), then `@inproceedings{heidari2026hairport, ...}` with `=` aligned in a column.
## Imagery
| Image | Type | Source size | Markdown | Rendered at 920px | Placement |
|---|---|---|---|---|---|
| teaser.png | PNG photo grid, row labels "Face" and "Hair" in serif type | 3455×1516 | `![]()
` in `` | 856×376 | Results Teaser, Figure 1 |
| paper_method.png | PNG method diagram, three stages | 2618×937 | `![]()
` | 856×306 | Method At A Glance, Figure 2 |
| method.png | PNG two-panel diagram (dataset generation, LoRA finetuning) | 2443×1457 | `![]()
` | 856×511 | Method At A Glance, Figure 3 |
All three figures are paper figures reused at full width, each with a numbered `` caption. The teaser is a 2×4 photo grid of source faces, reference hair and results; the method figures use pale blue and peach panels on white. No GIF, video or `` dark variant; the figures have white backgrounds and are designed for the light theme.
## Adapting to Other Content
- **A library.** Keep the h1, the three-line stacked paragraph (one-line description, version line, maintainers) and the for-the-badge row (Docs, PyPI, License, CI), then News and Installation separated by `---` rules; drop the numbered figures if there is nothing to show.
- **A dataset.** Make the badge row Dataset, Paper, License, and turn Results Teaser into a sample grid at `width="100%"` (856px) with a "Figure 1." caption; replace Pipeline Stages with a split table in the same `| # | Split | What it holds |` form.
- **A benchmark with scores.** Add a Results section after Method At A Glance with a pipe table, numeric columns right-aligned (`| ---: |`) and the best value in bold, introduced by a `Table 1.` caption to match the figure captions; HairPort has no results table, so this is an extension.
- **A repo without a teaser.** Move Method At A Glance up so Figure 1 is the method diagram, and keep the collapsed abstract under it.
- **A shorter README.** Keep the `---` rules only between the header and News and before Citation; with fewer than six sections, a rule before every heading looks heavy.
## Do's and Don'ts
| Do | Don't |
|---|---|
| Use one badge style (`for-the-badge`) for every badge in the row | Mix `flat` and `for-the-badge` badges |
| Name the artifact or its state in the message (BALDY, LIVE, COMING SOON) | Repeat the label in the message |
| Number every figure and caption it in `` with a bold "Figure N." | Leave full-width paper figures without a caption |
| Date news items with a bold month and year, newest first | Mix date formats within one list |
| Collapse the full abstract in `` | Paste the abstract above the badges |
| Keep each install step to one sentence and one tagged block | Put several unrelated commands in one untagged block |
## Agent Prompt Guide
1. "Write a README header in GitHub HTML: a centred `` with the short project name, one centred `
` holding a bold subtitle, `
`, a bold venue line, `
`, a plain author list; then one centred `
` of seven `?style=for-the-badge` shields.io badges with label #555555 and messages arXiv #b31b1b, DOI #2f6f9f, License #dc6f35, Project Page LIVE #2ea44f, Video COMING SOON lightgrey (#939393, unlinked), Weights #ffcc4d, Dataset #ff69b4; then a one-sentence summary and a `---` rule."
2. "After the header, write `##` sections separated by `---` in this order: News, Results Teaser, Method At A Glance, Repository Status, Installation, Quick Start, Pipeline Stages, Data Layout, Configuration, Standalone Tools, Project Structure, External Dependencies / Models, Acknowledgements, Citation, License. News items are `- **Month Year:** sentence with link`."
3. "Show each figure as `
Figure N. one sentence
`, put the abstract in `Paper Abstract
`, write install steps as `### 1. Step name` followed by one sentence and a `bash` block, and end with a `bibtex` block introduced by one sentence."
## Similar Pages
- readme-vveicao-freeorbit4d also uses `for-the-badge` badges under a centred title, but only two of them, and it shows results in HTML tables of GIFs instead of numbered figures.
- readme-sisyphm-studiorecon pairs a method figure with a stage table as HairPort's Pipeline Stages does, with flat badges and no news list.
- readme-microsoft-renderformer has a similar centred title and venue but replaces badges with a bold text-link row and adds a full table of contents.
## Quick Start
````markdown
ProjectName
Full Paper Title
Venue Year
A. Author, B. Author, and C. Author
One-sentence summary of what the method does.
---
## News
- **Month Year:** Announcement with an [inline link](https://example.org/).
---
## Results Teaser
Figure 1. One-sentence caption.
---
## Method At A Glance
Figure 2. One-sentence caption.
Paper Abstract
Abstract paragraphs.
---
## Installation
### 1. Create an environment
```bash
conda create -n name python=3.11 -y
```
---
## Quick Start
---
## Pipeline Stages
| # | Stage | What happens |
|---|-------|--------------|
| 1 | **Stage** | One sentence. |
---
## Citation
If you use ProjectName in your research, please cite:
```bibtex
@inproceedings{key,
title = {...},
}
```
---
## License
````
## Provenance
- Repo: https://github.com/deepmancer/HairPort (`README.md`, branch `main`, last README commit 9e258f3 on 2026-07-17).
- Paper: "HairPort: In-context 3D-aware Hair Import and Transfer for Images", SIGGRAPH Conference Papers '26 (SIGGRAPH 2026), arXiv 2606.12562, DOI 10.1145/3799902.3811046; first author Alireza Heidari. Project page https://deepmancer.github.io/HairPort/.
- Selection: for-the-badge badges in matched colors, a dated news list, and every figure carries a numbered caption like a paper, while a collapsible Paper Abstract and horizontal rules give long content a calm rhythm.
- Evidence: raw Markdown and GitHub-rendered HTML (saved 2026-10-28), 1440×900 and 2700px captures at a 920px README column, shields.io SVGs for all seven badge URLs, the three figure PNGs fetched from the repo for pixel sizes.
- Written 2026-10-28.
` on its own source line (the Video badge has no ``). Each badge is 28px tall; at 856px the row wraps after Project Page, giving four badges on the first row and three on the second. Details in Badges.
4. **Summary** (y≈345 to 370): one plain left-aligned Markdown sentence, two rendered lines, no bold.
5. **Rule** (y≈407): `---`, rendered by GitHub as a 4px (0.25em) bar in its border grey across the content width. The same rule separates every following section.
6. **News** (y≈450 to 670): `## News` and seven bullets; see Components.
7. **Results Teaser** (heading y≈747, image from about 785): `