{"id":28222185,"url":"https://github.com/hifza-khalid/github-readme-generator","last_synced_at":"2026-05-18T15:39:14.248Z","repository":{"id":287664999,"uuid":"959762452","full_name":"Hifza-Khalid/GitHub-README-Generator","owner":"Hifza-Khalid","description":"🚀This repo is for a GitHub README Generator app 🤖 that creates custom README.md files based on user inputs like GitHub details, skills 💻, tools 🛠, languages 🌐, and documentation preferences 📚.","archived":false,"fork":false,"pushed_at":"2025-04-13T08:52:20.000Z","size":3969,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-11T04:37:53.331Z","etag":null,"topics":["automation","development-tools","github","open-source","python","readme-generator","tkinter-gui"],"latest_commit_sha":null,"homepage":"https://github.com/Hifza-Khalid/GitHub-README-Generator","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Hifza-Khalid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-03T10:06:31.000Z","updated_at":"2025-04-13T09:47:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"30b488e6-b7dd-44d5-bcd5-fe4118e22a86","html_url":"https://github.com/Hifza-Khalid/GitHub-README-Generator","commit_stats":null,"previous_names":["hifza-khalid/github-readme-generator"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Hifza-Khalid/GitHub-README-Generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hifza-Khalid%2FGitHub-README-Generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hifza-Khalid%2FGitHub-README-Generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hifza-Khalid%2FGitHub-README-Generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hifza-Khalid%2FGitHub-README-Generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Hifza-Khalid","download_url":"https://codeload.github.com/Hifza-Khalid/GitHub-README-Generator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hifza-Khalid%2FGitHub-README-Generator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33183276,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-18T09:27:30.708Z","status":"ssl_error","status_checked_at":"2026-05-18T09:27:28.300Z","response_time":71,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","development-tools","github","open-source","python","readme-generator","tkinter-gui"],"created_at":"2025-05-18T06:10:16.546Z","updated_at":"2026-05-18T15:39:14.243Z","avatar_url":"https://github.com/Hifza-Khalid.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- Banner --\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/Hifza-Khalid/GitHub-README-Generator/blob/main/assets/banner.gif\" alt=\"GitHub README Generator Banner\" /\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eGitHub README Generator 🚀\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003eEmpower your projects with beautifully crafted README files — effortlessly! 💻✨\u003c/p\u003e\n\n\u003c!-- Motivational Quote --\u003e\n\u003cblockquote align=\"center\"\u003e\n  \u003cem\u003e\"A well-written README is the voice of your project — speak clearly, speak proudly.\" 🌟\u003c/em\u003e\n\u003c/blockquote\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Repo Size\" src=\"https://img.shields.io/github/repo-size/Hifza-Khalid/GitHub-README-Generator?color=blue\u0026style=flat-square\"/\u003e\n  \u003cimg alt=\"Last Commit\" src=\"https://img.shields.io/github/last-commit/Hifza-Khalid/GitHub-README-Generator?style=flat-square\u0026color=green\"/\u003e\n\u003cimg alt=\"MIT License\" src=\"https://img.shields.io/github/license/Hifza-Khalid/GitHub-README-Generator?style=flat-square\u0026label=License\u0026color=green\"/\u003e\n\n  \u003cimg alt=\"Languages\" src=\"https://img.shields.io/github/languages/count/Hifza-Khalid/GitHub-README-Generator?style=flat-square\"/\u003e\n\u003c/p\u003e\n\n---\n\n\u003cdetails\u003e\n  \u003csummary\u003e📑 \u003cstrong\u003eTable of Contents\u003c/strong\u003e (click to expand)\u003c/summary\u003e\n\n- [📌 Introduction](#-introduction)\n- [🧰 Features](#-features)\n- [🚀 Getting Started](#-getting-started)\n- [🔧 Installation](#-installation)\n- [📝 Usage (Step-by-Step)](#-usage-step-by-step)\n- [📸 Output (Screenshots)](#-output-screenshots)\n- [🛠 Technologies Used](#-technologies-used)\n- [🤝 Contributing](#-contributing)\n- [📚 Resources \u0026 References](#-resources--references)\n- [📄 License](#-license)\n\n\u003c/details\u003e\n\n---\n\n## 📌 Introduction\n\nWelcome to the **GitHub README Generator** — your personal assistant in crafting stunning, structured, and stylish `README.md` files for your GitHub profile and repositories.\n\nWhether you're showcasing your portfolio or documenting your latest open-source adventure, this tool saves time, boosts quality, and brings your project to life ✨\n\n---\n\n## 🧰 Features\n\n✔️ User-friendly GUI (Tkinter based)  \n✔️ Input your GitHub Username, Bio, Skills, Tools, Languages, Social Links  \n✔️ Clean markdown formatting  \n✔️ One-click `README.md` download  \n✔️ Output preview  \n✔️ Optional pandas for advanced data handling\n\n---\n\n## 🚀 Getting Started\n\n\u003e **\"Every big project starts with a simple setup. Let’s walk through it!\"**\n\n---\n\n## 🔧 Installation\n\n🔹 **Step 1: Clone the Repository**\n\nOpen your terminal or command prompt and run:\n```bash\ngit clone https://github.com/Hifza-Khalid/GitHub-README-Generator.git\ncd GitHub-README-Generator\n```\n\n🔹 **Step 2: Install the Required Packages**\n\nMake sure Python is installed. Then run:\n```bash\npip install -r requirements.txt\n```\n\n🔹 **Step 3: Run the Application**\n\nTime to launch your generator:\n```bash\npython main.py\n```\n\n---\n\n## 📝 Usage (Step-by-Step)\n\n\u003e **\"Don't just create a README, tell your story through it.\"**\n\n🔸 **Step 1:** Launch the App  \nRun the script and the GUI will appear.\n\u003cp align=\"center\"\u003e\n  \u003ch1\u003eSplash screen\u003c/h1\u003e\n  \u003cimg src=\"https://github.com/Hifza-Khalid/GitHub-README-Generator/blob/main/assets/splash_screen.JPG\" alt=\"GitHub README Generator Splash screen\" /\u003e\n  \u003ch1\u003eGUI_GitHub README Generator \u003c/h1\u003e\n  \u003cimg src=\"https://github.com/Hifza-Khalid/GitHub-README-Generator/blob/main/assets/reademe_generator.JPG\" alt=\"GitHub README Generator GUI\" /\u003e\n\u003c/p\u003e\n\n🔸 **Step 2:** Enter Your GitHub Details  \nProvide your GitHub username and a short bio that reflects your personality or project vision.\n\n🔸 **Step 3:** Choose Your Skills  \nTick boxes that reflect your core competencies — Python, JavaScript, etc.\n\n🔸 **Step 4:** Pick Your Favorite Tools  \nSelect from tools like VS Code, Git, Docker, etc.\n\n🔸 **Step 5:** Add Languages  \nMention the spoken or coding languages you work in.\n\n🔸 **Step 6:** Add Social Links  \nLink your GitHub, LinkedIn, Twitter, and more.\n\n🔸 **Step 7:** Click “Generate”  \nSit back and let your README come alive.\n\n🔸 **Step 8:** Preview \u0026 Download  \nReview your markdown, click to download, and proudly use it anywhere.\n\n---\n\n\u003cdetails\u003e\n  \u003csummary\u003e📸 \u003cstrong\u003eOutput (Screenshots)\u003c/strong\u003e\u003c/summary\u003e\n\n| 👇 Form Input | 🎯 After Profile Info | ✅ Output Preview |\n|--------------|----------------------|------------------|\n| ![Input Screenshot](https://user-images.githubusercontent.com/form-screenshot.png) | ![After Profile Screenshot](https://user-images.githubusercontent.com/after-profile.png) | ![Output Screenshot](https://user-images.githubusercontent.com/output-preview.png) |\n\n\u003c/details\u003e\n\n---\n\n## 🛠 Technologies Used\n\n- 🐍 Python  \n- 🖼️ Tkinter for GUI  \n- 📄 Markdown generation  \n- 🧪 Pandas (optional but powerful)\n\n---\n\n## 🤝 Contributing\n\nWe believe in the power of collaboration 🙌\n\n1. Fork this repository 🍴  \n2. Create a branch (`git checkout -b feature-name`)  \n3. Commit your work (`git commit -m 'Added awesome feature'`)  \n4. Push to your branch (`git push origin feature-name`)  \n5. Open a Pull Request 🚀\n\n---\n\n## 📚 Resources \u0026 References\n\n- 🧠 [Markdown Cheatsheet](https://www.markdownguide.org/cheat-sheet/)  \n- 🎨 [Shields.io Badges](https://shields.io/)  \n- 📘 [Tkinter Docs](https://docs.python.org/3/library/tkinter.html)  \n- 💬 [How to Write a Great README](https://www.makeareadme.com/)  \n- 🎥 [Tkinter YouTube Tutorials](https://www.youtube.com/playlist?list=PL1FgJUcJJ03vY_fV4OaRSCgN_N3AAi7yL)\n\n---\n\n## 📄 License\n\nThis project is licensed under the **MIT License** — see the [LICENSE](LICENSE) file for full details.\n\n---\n\n\u003e 🔥 _“Turn your README into a reflection of your passion. Because great code deserves great documentation.”_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhifza-khalid%2Fgithub-readme-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhifza-khalid%2Fgithub-readme-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhifza-khalid%2Fgithub-readme-generator/lists"}