docs: enhance README with modern layout and comprehensive information#2022
docs: enhance README with modern layout and comprehensive information#2022TenSoja wants to merge 3374 commits into
Conversation
replaces DataManipulationForm Removed the DataManipulationForm class
Created the static method DataHandlingForm::openNewWindow Making DatabaseExplorerWidget use DataHandlingForm::openNewWindow instead of having its own version of that method. Minor adjustment in DataGridWidget and DataHandlingForm to open connections on demand instead of leaving them open until the windows are closed.
GlobalAttributes::UiStyleOption
duplicated schemas and use the ones already available in the model
SQLExecutionWidget
the option "Import to the working model" in DatabaseImportForm
model option is set on DatabaseImportHelper and DatabaseImportForm
correctly on macOs
- Add professional badge layout with key project metrics - Restructure content with clear sections and improved readability - Highlight technical excellence: 96.5% C++17 codebase with modern features - Emphasize 19 years of continuous development (2006-2025) - Add performance achievements and engineering highlights - Include creator spotlight and project legacy section - Reorganize content to eliminate redundancy and improve flow - Add collapsible known issues section for better UX - Update requirements: Qt 6.4+, PostgreSQL 17 support - Enhance call-to-action sections for donations and contributions This update transforms the README into a more engaging and informative document that better represents pgModeler's maturity and technical quality while maintaining all essential information for users and contributors.
There was a problem hiding this comment.
Pull Request Overview
This PR completely revamps the README.md to provide a more professional, comprehensive, and engaging documentation that better represents pgModeler's 19 years of development history and technical capabilities.
- Transforms the layout from basic text to a modern, visually appealing format with badges, emojis, and structured sections
- Adds comprehensive technical details including C++17 features, performance metrics, and architectural highlights
- Updates project requirements (Qt 6.4+, PostgreSQL 17 support) and corrects the project timeline to 19 years
Comments suppressed due to low confidence (1)
README.md:1
- The emoji character appears to be corrupted or incomplete. It should be a globe emoji (🌍) for internationalization.
<p align="center">
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|  | ||
| <p align="center"> | ||
| <img src="https://img.shields.io/github/v/release/pgmodeler/pgmodeler" alt="Latest Release" /> | ||
| <img src="https://img.shields.io/badge/Downloads-500K%2B_Total-brightgreen" alt="Total Downloads" /> |
There was a problem hiding this comment.
The downloads badge appears to be a custom/hardcoded value ('500K+ Total') rather than a dynamic badge from an official source. Consider using an actual metric source or removing this badge to avoid maintaining outdated numbers.
| <img src="https://img.shields.io/badge/Downloads-500K%2B_Total-brightgreen" alt="Total Downloads" /> |
| ## 💖 Support pgModeler's Development | ||
|
|
||
| This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | ||
| pgModeler is **100% independent** with **19 years** of continuous development. Your support keeps this project alive! |
There was a problem hiding this comment.
The '19 years' claim is repeated multiple times throughout the document (lines 24, 76, 159). Consider using a consistent reference or variable to avoid maintenance issues when this number needs to be updated.
| ### 🎯 How You Can Help | ||
|
|
||
| See [LICENSE](https://github.com/pgmodeler/pgmodeler/blob/main/LICENSE) for details. | ||
| * 💰 **Financial Support** - pgModeler lives exclusively from [donations](https://pgmodeler.io/#donationForm) and [package purchases](https://www.pgmodeler.io/purchase). Your contribution directly supports development! |
There was a problem hiding this comment.
The '19 years' claim is repeated multiple times throughout the document (lines 24, 76, 159). Consider using a consistent reference or variable to avoid maintenance issues when this number needs to be updated.
| ## 🏆 Technical Excellence | ||
|
|
||
| ### 💎 **Crafted with Pride: Modern C++17 & Qt** | ||
| - **96.5% C++** codebase with **professional-grade architecture** |
There was a problem hiding this comment.
The '96.5% C++' statistic is hardcoded and repeated in multiple places. This percentage may change over time as the codebase evolves, creating maintenance burden to keep it accurate across all references.
| - **96.5% C++** codebase with **professional-grade architecture** | |
| - **Predominantly C++** codebase with **professional-grade architecture** |
|
|
||
| :card_file_box: Older Releases & Code | ||
| ------------------- | ||
| **Raphael Araújo e Silva** - The passionate C++ developer behind pgModeler since 2006. Living in Palmas, Brazil, Raphael combines **computer graphics**, **compilers**, and **database systems** knowledge into this masterpiece. His dedication to **clean C++ code** and **Qt framework expertise** shows in every line of the 96.5% C++ codebase. |
There was a problem hiding this comment.
The '96.5% C++' statistic is hardcoded and repeated in multiple places. This percentage may change over time as the codebase evolves, creating maintenance burden to keep it accurate across all references.
| **Raphael Araújo e Silva** - The passionate C++ developer behind pgModeler since 2006. Living in Palmas, Brazil, Raphael combines **computer graphics**, **compilers**, and **database systems** knowledge into this masterpiece. His dedication to **clean C++ code** and **Qt framework expertise** shows in every line of the 96.5% C++ codebase. | |
| **Raphael Araújo e Silva** - The passionate C++ developer behind pgModeler since 2006. Living in Palmas, Brazil, Raphael combines **computer graphics**, **compilers**, and **database systems** knowledge into this masterpiece. His dedication to **clean C++ code** and **Qt framework expertise** shows in every line of the predominantly C++ codebase. |
📝 Summary
This PR completely revamps the README.md to provide a more professional, comprehensive, and engaging documentation that better represents pgModeler's 19 years of excellence and technical sophistication.
🚀 Key Improvements
Visual & Layout
Content Enhancements
Information Updates
User Experience
🎯 Why This Matters
pgModeler is an incredible project that deserves documentation that matches its quality. This README now:
📊 Before vs After
Before: Basic text-heavy layout with duplicated info and outdated metrics
After: Professional, comprehensive documentation worthy of this amazing project
✅ Checklist
This update transforms the README into a document that truly represents pgModeler's status as the premier PostgreSQL database modeler! 🐘✨