Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nstechbytes/readme-pro
*Readme Pro** is a powerful GitHub README generator application designed to help you create professional and visually appealing README files for your GitHub projects. It allows you to easily input your personal information, skills, projects, and social media links, generating a formatted Markdown file ready for use on your GitHub profile.
https://github.com/nstechbytes/readme-pro
developer-tools documentation github gui markdown open-source project-management pyqt python readme-generator
Last synced: about 1 month ago
JSON representation
*Readme Pro** is a powerful GitHub README generator application designed to help you create professional and visually appealing README files for your GitHub projects. It allows you to easily input your personal information, skills, projects, and social media links, generating a formatted Markdown file ready for use on your GitHub profile.
- Host: GitHub
- URL: https://github.com/nstechbytes/readme-pro
- Owner: NSTechBytes
- License: apache-2.0
- Created: 2024-09-24T14:55:11.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-24T15:12:01.000Z (3 months ago)
- Last Synced: 2024-10-29T14:49:27.243Z (2 months ago)
- Topics: developer-tools, documentation, github, gui, markdown, open-source, project-management, pyqt, python, readme-generator
- Language: Python
- Homepage:
- Size: 62.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Readme Pro
## Description
**Readme Pro** is a powerful GitHub README generator application designed to help you create professional and visually appealing README files for your GitHub projects. It allows you to easily input your personal information, skills, projects, and social media links, generating a formatted Markdown file ready for use on your GitHub profile.
## Features
- **User-Friendly Interface**: Intuitive layout for easy input of personal and project details.
- **Dynamic Preview**: See your README content update in real-time as you input your data.
- **Skill Badges**: Automatically generate skill badges based on your inputs.
- **Social Media Links**: Include links to your GitHub, Twitter, LinkedIn, Instagram, YouTube, Facebook, and personal website.
- **Project Management**: Add and manage multiple projects with tags.
- **Export to Markdown**: Save your generated README as a Markdown file.
## Installation
1. Clone the repository:
```bash
git clone https://github.com/NSTechBytes/Readme-Pro.git
```
2. Navigate to the project directory:
```bash
cd Readme-Pro
```
3. Install the required packages:
```bash
pip install PyQt5
```
## Usage
1. Launch the application:
```bash
python Readme Pro.py
```
2. Fill in your details in the respective tabs:
- **Info**: Enter your name, bio, and profile image URL.
- **Skills**: List your skills and their proficiency levels.
- **Projects**: Add your projects with tags for better organization.
3. Click on **Generate README** to see a preview of your README.
4. Use the **Save README** button to export your generated Markdown file.
## Icons Used
- [Font Awesome](https://fontawesome.com/) for icons.
- Custom icons created for the application.
## License
This project is licensed under the APPACHE License - see the [LICENSE](LICENSE) file for details.
## Contributing
Contributions are welcome! If you have suggestions for improvements or new features, please feel free to fork the repository and submit a pull request.
## Acknowledgments
- Thanks to the open-source community for their resources and tools that helped in the development of this project.
## Contact
For inquiries, please reach out to:
- GitHub: [NS Tech Bytes](https://github.com/NSTechBytes)
- Email: [email protected]