GitHub README

ASCII art for GitHub README

Create a project title or section divider, then copy the ASCII and Markdown together. No account or installation needed.

Build your README

Use the banner above, add your project details and download one Markdown file.

Start with a complete example

Choose a simple Python project, a library or a command-line tool. Adapt the example text and commands to your project; your current banner stays unchanged.

Simple project

A short introduction, a working command and contribution notes.

Python library

A small reusable module with an example import.

Command-line tool

A terminal command with input and expected output.

Download the runnable examples (ZIP, English)

README preview

README preview
Full Markdown

These fields stay in this page and are not included in the banner share link. Installation and usage are copied as code; description and contribution notes as plain text.

Put your banner in a README

  1. Enter your project name above and choose a font. Small and Mini are useful starting points for compact titles.
  2. Check the number of columns. A target of 80 is useful on desktop; use a narrower banner when mobile readers matter.
  3. Choose Copy Markdown and paste into your README. The opening and closing code fences are included.
  4. Keep a normal Markdown heading next to the banner so the project name remains readable without the artwork.

Why the code block matters

Spaces and line breaks define the picture. A fenced code block preserves the monospace layout; ordinary Markdown paragraphs do not. Copy Markdown wraps your result without adding a syntax-highlighting language.

```
+------------+
| MY PROJECT |
+------------+
```

Choose a width for your readers

There is no single width that fits every phone, font size and GitHub view. The generator reports the actual width of your banner and warns when it exceeds the target you select. A compact font or shorter title reduces the width without stretching or shrinking the characters. Preview your README on the devices you care about.

Headers, dividers and logos

Use a title at the top and shorter dividers for Installation, Usage and Contributing. For a picture-based project logo, try the image converter. For more fonts and PNG exports, open the full text generator.

Keep the information accessible

ASCII art can be difficult for screen readers. Put essential names, commands and instructions in ordinary text too, and use banners as decoration rather than the only way to convey information.

Ready-made README sections

Copy a section now, or personalize its text and frame.

Project header

README
+------------+
| MY PROJECT |
+------------+
Personalize

Installation section

README
-- INSTALLATION ------------------------
Personalize

Usage section

README
-- USAGE -------------------------------
Personalize

Contributing section

README
-- CONTRIBUTING ------------------------
Personalize