FAQ
Short answers to the questions people ask before installing.
Is it free?
Yes. The generator, the GitHub Action and all styles are free and open source (MIT).
Do I need to sign in or give access?
No. You never sign in here. The Template route runs inside your own repository with a temporary token GitHub creates for each run. It can only touch that one repository.
How often do the stats update?
Template and AI agent routes: every day, and right after you edit atelier.yml. Copy & paste: every few hours.
Will it overwrite my current README?
Only the part between the Readme Atelier markers is replaced. The first time, your old README is saved to atelier/README.backup.md.
How do I change things later?
Edit atelier.yml in your profile repository and commit. The profile rebuilds in about a minute. Or generate again here and paste the new settings.
Are private contributions counted?
Only if “Private contributions” is enabled on your GitHub profile. For exact totals, add a personal token as a repository secret and pass it to the Action as token.
Light or dark GitHub theme?
Most styles have their own background and look the same in both. Editorial ships two versions and GitHub picks the right one automatically.
Why don’t the animations move?
They play on GitHub in any modern browser. If “reduce motion” is on in your system settings, they stay still on purpose.
How do I remove it?
Delete the atelier folder, atelier.yml and .github/workflows/readme-atelier.yml, then edit README.md.
Can I make my own style?
Yes. A style is one TypeScript file. Follow the guide and open a pull request; new styles appear here after review.