Generate a README

Use README generation to create a concise entry point for a repository. It complements a full documentation Space by telling readers what the project is and where to begin.

Create the draft

  1. Import the repository through Git Connections.
  2. Open README generation in the repository tools.
  3. Choose the repository, desired sections and output language.
  4. Select the appropriate license option and add factual instructions where needed.
  5. Start generation and review the returned Markdown.

Check the parts readers will use

Verify installation commands, runtime requirements, configuration names and the first usage example. Ensure the license statement matches the project's actual license; choosing a label in a generator does not change the repository's license.

Keep detailed architecture and endpoint references in their own pages and link to them. A README should give readers a successful first step without reproducing the entire documentation tree.

Save and share

Edit the draft, download it, add it to a Space or use the available sharing action. The saved result is accessible through Generations.

Generation does not commit the README to Git. Exporting or applying it to a repository is a separate reviewed action.

If a repository is missing, check its import status. If a section is missing, confirm it was selected and either edit the draft or generate a revised version with clear instructions.

Updated