A CLEARER HANDOFF FOR YOUR FILES

README Collection Guide Builder

Create clear folder descriptions, software requirements and contact notes for an archive.

Worked exampleBrowser processingUseful downloads

A clear result starts here

Add your input or try the worked example.

Using README Collection Guide Builder

Create clear folder descriptions, software requirements and contact notes for an archive.

Use Try example to explore readme collection guide builder, or enter your own collection title.
Set purpose and provenance, folder guide csv / json, required software / versions. Read the field notes for supported values.
Choose Build collection README and inspect the result, including any review flags or unsupported cases.
Use the relevant download buttons to keep your result. CSV and report JSON preserve the available findings; original files are not changed.

Example

Collection title: Community archive sample
Purpose and provenance: Approved photographs and interview transcripts for the October exhibit.
Folder guide CSV / JSON: path,description
photos/,Original approved images
transcripts/,Reviewed interview text
exports/,Public delivery copies
Required software / versions: Any UTF-8 text editor. Image viewer with PNG support.
Contact or organization (optional): Community archive team
Rights and reuse notes: Consult each item’s supplied permission record before reuse.

Questions & answers

What does README Collection Guide Builder do?

Create clear folder descriptions, software requirements and contact notes for an archive.

What input does this tool support?

Collection title. Purpose and provenance. Folder guide CSV / JSON: Columns: path,description. Required software / versions. Contact or organization (optional). Rights and reuse notes

What should I check before using the result?

Uses only supplied collection facts. It does not verify rights, preservation quality or the availability of software.

Can I keep or share the result?

Yes. Use the result-specific downloads, CSV where available and report JSON. Downloads can contain your supplied information, so review the content before sharing. Processing runs in this browser; public pages also include the site’s approved advertising and optional analytics.