# Add ASCII art to a GitHub README

Put your drawing in a fenced code block in the README. It stays part of the Markdown source and can be edited with the rest of the document.

[Add ASCII art to a GitHub README](https://asciilab.app/en/guides/add-ascii-art-to-a-github-readme/)

## Three steps

1. Open README.md in a plain text editor and paste a heading or a brief caption.
2. Put the art on its own lines between two fences of three backticks.
3. Preview the rendered Markdown and check how the block appears in a narrow browser window.

~~~text
# Build status

```
+---------+
|  READY  |
+---------+
```
~~~

## Keep the source easy to edit

Use spaces instead of tabs inside the block and leave out a language label if you want plain text. Store the entire drawing in a TXT file when you reuse it in multiple documents, and keep copies short enough to scan in the Markdown source.

## Keep the information in regular prose

For a banner containing a project name, include the actual project name in a Markdown heading as well. The character image can decorate the page while the heading remains ordinary searchable text.

## Choose the display format deliberately

A code block keeps the characters copyable. An image can be better for a detailed logo that takes more space than you want to use in the README. Give an image meaningful alternative text and keep the TXT source for editing.

## Questions

### What should I check in the Markdown preview?

Check the start and end of the code block, the alignment of the lines and whether the block takes too much horizontal space.

## Related pages

- [Text to ASCII art](https://asciilab.app/en/tools/text-to-ascii/)
- [Make a terminal banner with FIGlet](https://asciilab.app/en/guides/make-a-terminal-banner-with-figlet/)
- [Save ASCII art as a TXT file](https://asciilab.app/en/guides/save-ascii-art-as-txt/)
- [Export ASCII art as a PNG](https://asciilab.app/en/guides/export-ascii-art-as-png/)

[Get the iPhone app](https://apps.apple.com/app/id6789541973?ct=web-guide-add-ascii-art-to-a-github-readme)
