Skip to content

Update README.md #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TFQ0 merged 1 commit into from
Sep 6, 2026
Merged

Update README.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 3 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,15 @@
# Animated GitHub Profile Studio

A desktop-only visual editor for building animated GitHub profile READMEs from one reusable configuration. Design the profile, preview every theme and motion mode, then export a complete repository-ready bundle.
A desktop visual editor for building animated GitHub profile READMEs from one reusable configuration. Design the profile, preview every theme and motion mode, then export a complete repository-ready bundle.

<p align="center">
<img src="./assets/profile-header-dark.svg" alt="Fictional desktop GitHub profile generated by Animated GitHub Profile Studio" width="100%">
</p>

<p align="center">
<a href="https://tfq0.github.io/animated-github-profile/"><strong>Open the hosted Studio</strong></a>
·
<a href="./SETUP.md">Setup and release guide</a>
·
<a href="./USER_CONTENT_NOTICE.md">Content notice</a>
<a href="https://tfq0.github.io/animated-github-profile/"><strong>Open the Website</strong></a>
</p>

The header above is a committed example generated by the Studio. Its identity, repositories, and links are intentionally fictional and safe to replace.

## What the Studio does

Animated GitHub Profile Studio turns a validated `profile.config.json` into a polished profile README and four self-contained desktop SVG headers:

- Dark animated
- Light animated
- Dark static
- Light static

Every header uses a fixed 1200 × 610 desktop canvas. The editor targets browser widths of 1180 px or wider and does not generate a separate phone layout.

## Highlights

- Seven distinct designs: Quality Control, Classic Terminal, Retro Arcade, Anime HUD, Bento Grid, Signal Poster, and Custom Canvas.
Expand All @@ -43,7 +26,7 @@ Every header uses a fixed 1200 × 610 desktop canvas. The editor targets browser

## Create a profile

1. Open the [hosted Studio](https://tfq0.github.io/animated-github-profile/) or run it locally.
1. Open the [Website Studio](https://tfq0.github.io/animated-github-profile/) or run it locally.
2. Choose a design, start with a blank profile, or load the clearly labeled fictional sample.
3. Customize the profile content and desktop composition.
4. Review the dark/light and animated/static previews.
Expand Down
Loading