Simple project
A short introduction, a working command and contribution notes.
Create a project title or section divider, then copy the ASCII and Markdown together. No account or installation needed.
Use the banner above, add your project details and download one Markdown file.
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.
A short introduction, a working command and contribution notes.
A small reusable module with an example import.
A terminal command with input and expected output.
Replace the current README fields with this example? Your banner will stay unchanged.
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.
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 | +------------+ ```
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.
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.
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.
Copy a section now, or personalize its text and frame.
+------------+ | MY PROJECT | +------------+
-- INSTALLATION ------------------------
-- USAGE -------------------------------
-- CONTRIBUTING ------------------------