Project Logo¶

A project logo is a visual representation of your project that appears at the top of your README file. It helps to brand your project and make it more recognizable. README-AI offers various options for adding a logo to your project's README.

Default Options¶

Use the --image option to select from the following logo styles:

How It Works¶

README-AI provides several ways to include a logo in your project's README:

1. Default Images: Choose from a set of pre-defined logos.
2. Custom Images: Use your own image by providing a URL or file path.
3. LLM Images: Generate a unique logo using AI (requires an LLM API).

The selected or generated logo will be placed at the top of your README file, helping to visually identify your project.

Usage¶

Selecting a Default Image¶

To use one of the default images, specify the image name with the --image option:

readmeai --image gradient --repository https://github.com/username/project

Providing a Custom Image¶

You can provide readme-ai with a custom image by using the --image custom option:

readmeai --image custom --repository https://github.com/username/project

You will be prompted to provide a path to your image on your local machine or via URL:

Provide an image file path or URL:

LLM Image Generation¶

To generate a logo using a text-to-image model from a LLM API (i.e. OpenAI), use the --image llm option:

readmeai --image llm --api openai --repository https://github.com/username/project

This will generate a unique logo that you can display in your project's documentation. The prompt used for text-to-image generation can be found here.

The quality and relevance of LLM-generated logos can vary. It's a good idea to review and potentially edit the generated logo to ensure it meets your project's needs.

Tips for Using Project Logos¶

• Choose a logo that represents your project's purpose or theme.
• Ensure the logo is clear and recognizable even at smaller sizes.
• If using a custom image, make sure it's high quality and appropriately sized.
• When using LLM-generated logos, you may want to generate several options to choose from.
• Consider how the logo will look alongside your project's badges and other README content.
• If your project is part of a larger organization or ecosystem, consider using a logo that aligns with that branding.