` blocks, acknowledgements, contact section, venue line in the header (the ICML 2026 Spotlight acceptance is not mentioned anywhere in the README), equal-contribution marks.
Present but unusual: the citation is the first `##` section, before the table of contents; the table of contents lists "Docker" as a child of Installation although ๐ณ Docker is its own `##` section; emoji headings produce anchors with a leading hyphen (`#-installation`, `#-docker`), which the table of contents uses correctly; every emoji `##` section is preceded by a `---` rule, so GitHub draws a 4px rule above each heading on top of the heading's own 1px bottom rule; the logo has an empty `alt`.
## Components
**Logo-in-heading.** `
Name
`: an SVG mark at 36px height sitting on the h1 text line, separated by one non-breaking space.
**Flat badge row.** Four `
` lines in a ``. Label #555555; messages #b31b1b, #67ac09, #dd4343, #007ec6. Label is the kind of resource (arXiv, Project, Video, License), message the specific item.
**Captioned figure.** `
![]()
` followed by `Bold title sentence. Several explanatory sentences.
`. The caption is long and centred; the bold sentence acts as the figure title. Used twice, for the teaser and for the robot-evaluation figure.
**Nested table of contents.** A Markdown bullet list with two-space-indented children, each entry an anchor link (`[Local Install](#local-install)`). Top-level entries drop the emoji but link to the emoji anchors.
**Section dividers.** `---` on its own line before each emoji `##` heading.
**Numbered bold steps.** `1. **Install submodules**:` then a three-space-indented `sh` or `yaml` block, so the code sits inside the list item. Sizes and wait times appear in parentheses in the step title ("(~72GB, requires Git LFS)").
**Callouts.** Plain GitHub blockquotes, not alert syntax: `> **Important:** ...` and `> **Note:** ...`, sometimes followed by a numbered list of anchor links inside the quote. A short unbolded `>` line opens Installation.
**Code blocks.** Fenced with `sh` (51 blocks), `yaml` (5), `python` (1) and `bibtex` (1). Many are a single command introduced by a one-line sentence ending in a colon ("Install uv:"). Shell blocks carry `#` comment lines for alternatives ("# Force single GPU mode").
**Path table.** One three-column pipe table (Host Path, Container Path, Content) with plain `|-----|` delimiters and inline code in the first two columns.
**License line.** One sentence, "This project is licensed under the MIT License - see [LICENSE](LICENSE) for details."; no acknowledgements.
## Imagery
| Image | Type | Source size | Markdown | Rendered at 920px | Placement |
|---|---|---|---|---|---|
| media/symbol.svg | SVG logo, triangle with teal, periwinkle and peach faces and dark outlines | viewBox 90.07ร78 | `![]()
` inside the h1 | about 42ร36 | left of the title text |
| media/teaser.webp | static WebP, annotated 3D render on white | 1946ร1265 | `![]()
` in `` | 856ร556 | header, after the authors; bold-italic centred caption below |
| media/robot_eval.webp | static WebP, pipeline figure on white | 2917ร1565 | same pattern, `width="100%"` | 856ร459 | top of ๐ค Robot Evaluation, after one paragraph; bold-italic centred caption below |
The teaser is a single rendered scene used as an explainer: a top-down cutaway of every room, with circular insets ringed in cyan #42c8f4, dashed cyan arrows to separate object crops, and serif call-outs that quote the prompt ("The storage room has shelves with boxes."). The robot-evaluation figure follows the same visual language with cyan #12b7d4 and orange #db692b. Both are single-frame WebPs, neither uses `` or a dark-theme variant, and the overview video is a YouTube badge link rather than an embed.
## Adapting to Other Content
- **A library.** Keep the logo-in-h1 and the one-line "Code for ..." paragraph (rewritten as "A library for ..."), the four flat badges (Docs, PyPI, Video, License) and the nested table of contents; replace the teaser with a short usage example and drop the author block.
- **A dataset.** Make the teaser a single annotated sample at `width="100%"` (856px) with a bold-italic caption that states counts, and promote ๐พ Data Setup to the first section after the table of contents.
- **A benchmark with scores.** Add a `## ๐ Results` section after Scene Generation with a pipe table, right-aligned numeric columns (`---:`) and bold best values; SceneSmith itself has no results table.
- **A repo without a teaser.** Let the badge row and author block close the header and move the citation directly under them, as SceneSmith already does.
- **A short README.** Drop the table of contents and the `---` dividers; both pay off only when there are eight or more long `##` sections.
## Do's and Don'ts
| Do | Don't |
|---|---|
| Let one annotated full-width figure explain the contribution | Stack several small teaser images in the header |
| Caption the figure with a bold title sentence followed by italic explanation | Leave a dense figure with no caption |
| Put the citation right after the header in a long README | Bury BibTeX after eight operational sections |
| Use a nested table of contents when the README has eight or more `##` sections | Repeat the table of contents in every section |
| Write install steps as numbered bold titles with indented `sh` blocks | Run multi-step installs as one long unexplained shell block |
| Flag incomplete setup with `> **Important:**` and anchor links to the missing steps | Hide required downloads in prose |
| Keep the badge row to four flat badges with the #555555 label | Add the venue or star counts as extra badges without need |
## Agent Prompt Guide
1. "Write a README header in GitHub Markdown: `` with an SVG logo at `height="36" align="absmiddle"`, ` ` and the project name; a centred `
` reading `Code for "Full Paper Title".`; a centred row of four flat shields.io badges (label #555555; arXiv ID #b31b1b, Project Website green #67ac09, Video Overview red #dd4343, License MIT blue #007ec6); a centred author paragraph with `` marks, `
`, then the affiliations; a `width="100%"` teaser; and a centred `` caption that opens with a `` title sentence."
2. "After the header, put `## Citation` with a `bibtex` block, then `## Table of Contents` as a nested bullet list of anchor links, then `---`. Write the body as emoji `##` sections, each preceded by `---`: ๐ฆ Installation, ๐ณ Docker, ๐พ Data Setup, ๐ฌ Scene Generation, ๐ Visualization, ๐ค Export, ๐ค Robot Evaluation, ๐งช Testing, ๐ License."
3. "Inside each section use h3 and h4 subsections, numbered steps with a bold title and an indented `sh` or `yaml` block, `> **Important:**` callouts that list missing steps as anchor links, and one three-column path table. Place any second figure at `width="100%"` with the same bold-italic centred caption form."
## Similar Pages
- readme-leggedrobotics-d3-skill-discovery, readme-microsoft-renderformer and readme-seohongpark-ogbench also combine a table of contents with `` blocks for long operational content; SceneSmith uses a table of contents and `---` dividers but no ``.
- readme-letianhuang-transparentgs and readme-yrainy0615-gaussianplant are other 3D-vision READMEs in the set with collapsible sections, for comparison with SceneSmith's fully expanded layout.
- SceneSmith's distinguishing choices are a single annotated teaser with a long bold-italic caption and the citation placed before the table of contents. Its project page (scenesmith.github.io) is a separate web page and is not described here.
## Quick Start
````markdown
ProjectName
Code for "ProjectName: Full Paper Title".
Author One1,
Author Two2
1Institution A,
2Institution B
Bold figure title. Several sentences explaining what the figure shows.
## Citation
```bibtex
@misc{key2026,
title={...},
}
```
## Table of Contents
- [Installation](#-installation)
- [Local Install](#local-install)
- [Data Setup](#-data-setup)
- [License](#-license)
---
## ๐ฆ Installation
> For Docker-based setup, see [Docker](#-docker) below.
### Local Install
Install the dependencies:
```sh
uv sync
```
1. **Step title** (~size):
```sh
bash scripts/install.sh
```
> **Important:** Installation is not complete yet. Continue with:
> 1. [Data Setup](#-data-setup)
---
## ๐ณ Docker
---
## ๐พ Data Setup
---
## ๐ฌ Scene Generation
```sh
python main.py +name=run_name
```
---
## ๐ License
This project is licensed under the MIT License - see [LICENSE](LICENSE) for details.
````
## Provenance
- Repo: https://github.com/nepfaff/scenesmith (`README.md`, branch `main`, last README commit 9df3f88 on 2026-02-11).
- Paper: "SceneSmith: Agentic Generation of Simulation-Ready Indoor Scenes", ICML 2026 Spotlight, arXiv 2602.09153; first author Nicholas Pfaff. Project page https://scenesmith.github.io/.
- Selection: one large annotated hero figure with a long italic caption does all the explaining, and the citation placed early plus a nested table of contents suit a long, operations-heavy README.
- 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 the four badge URLs, `media/symbol.svg`, `media/teaser.webp` and `media/robot_eval.webp` fetched from the repo for sizes and colors.
- Written 2026-10-28.
` lines. Flat style, 20px tall; widths 116, 102, 102 and 82px, so the row spans about 414px. Details in Badges.
4. **Authors and affiliations** (yโ258 and 282): one `