- Notifications
You must be signed in to change notification settings - Fork52
Generate a cool README/About me page for your Github Profile
License
rahulbanerjee26/githubProfileReadmeGenerator
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation

- How to create a GitHub Profile README using this web app on RealPythonProjet.
The article contains resources for GIFs, royalty free images/icons and tutorials on how to create your secret repo for the About Me Page, setting up the blog flow action etc.
- Fill in the text boxes. Leave the ones you do not wish to fill blank.
- By default the generated ReadMe has GitHub stats and Wakatime stats, feel free to remove them.
- If you want to build on top of the Readme, refer to the article I mentioned above for resources and tips
- If you used this app to build your README, consider adding yourself to the "Users who used this app to generate a README" section. You can showcase your README and others will be able to view it and star it. You are guaranteed a star from me ⭐
- GIFs
- Social Icons
- Skill Icons
- Visitors Badge
- Github Stats
- WakaTime Stats
- .yml file to display Blog Posts from your feed
- Ability to add image banners at beginning of README
- Random Jokes Card
- Clicking on Skills shows your github repos filtered on that skill
- Chose GitHub Stats Card Type
- Cool Image in About Me section
- Fixed styling
- Added Default Content
- Fixed Some Gif Issues
- Added Banner Images Sugesstions
- Updated Streamlit beta elements
- Clone the repo or your fork.
- Create a virtual environment
python -m venv venv
- Activate the virtual environment
# Windowsvenv/Scripts/activate# Linux/macOSsource venv/bin/activate
- Install required dependencies
pip install -r requirements.txt
- Run the App
streamlit run __init__.py
- Rahul Banerjee -@rahulbanerjee26banerjeer2611@gmail.com
- Michael Currin -@MichaelCurrin
Go toIssues on the repo.
- Create an explaining the Feature.
- If you find any errors/issues, feel free to create an Issue.
How to make code changes and add them to this repo with a Pull Request.
- Fork the Project
- Clone it using the URL from the Code button.
git clone FORK_URL
- Create your Feature Branch
git checkout -b feat-my-feature
- Commit your Changes
git commit -m'Add some Amazing Feature'
- Push to the Branch
git push origin feat-my-feature
- Go toPull Requests of the original repo.
- Create a Pull Request. Compare across forks and pick your fork and your branch.
Once your PR is merged, I will add you as a contributor :)
Or if you wish to add yourself to 'Users who used this app' list, simply fork the repo, update the README and make a PR. Follow this format:
- <ahref ='https://github.com/USERNAME'> DISPLAY NAME </a>
Or just reach out to me on Twitter/LinkedIn and I'll add you :)
To keep your fork's main branch up to date with that of the original repo, then on your fork on GitHub click the Fetch Upstream button near the top.
- Adding more badges
- Giving user ability to chose between different ReadMe designs
- Increasing number of social Icons
- Distributed under the
MIT License
. SeeLICENSE for more information.
About
Generate a cool README/About me page for your Github Profile
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Releases
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors12
Uh oh!
There was an error while loading.Please reload this page.