-
-
Notifications
You must be signed in to change notification settings - Fork 411
docs: enhance README with modern layout and comprehensive information #2022
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
TenSoja
wants to merge
1
commit into
nullptrlabs:develop
Choose a base branch
from
TenSoja:feature/improve-readme-documentation
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,67 +1,160 @@ | ||||||
|  | ||||||
| <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" /> | ||||||
| <img src="https://img.shields.io/github/stars/pgmodeler/pgmodeler" alt="GitHub Stars" /> | ||||||
| <img src="https://img.shields.io/github/license/pgmodeler/pgmodeler" alt="License" /> | ||||||
| <img src="https://img.shields.io/badge/PostgreSQL-17%20Ready-blue?logo=postgresql" alt="PostgreSQL Support" /> | ||||||
| </p> | ||||||
|
|
||||||
| <h1 align="center">🐘 pgModeler</h1> | ||||||
| <p align="center"><strong>The Premier Open-Source PostgreSQL Database Modeler</strong></p> | ||||||
| <p align="center">Since 2006 • Professional-grade • Cross-platform excellence</p> | ||||||
|
|
||||||
| <p align="center"> | ||||||
| <img src="https://user-images.githubusercontent.com/2205476/213446508-9bd549b3-ee7f-476d-9249-f537c31fce04.png" alt="pgModeler Main Window" /> | ||||||
| </p> | ||||||
|
|
||||||
| ## 🎯 Why Choose pgModeler? | ||||||
|
|
||||||
| ✅ **Visual Database Design** - Design PostgreSQL databases visually with drag-and-drop interface | ||||||
| ✅ **Reverse Engineering** - Import existing databases and visualize their complete structure | ||||||
| ✅ **Smart Diff & Sync** - Compare models with databases and generate precise migration scripts | ||||||
| ✅ **Code Generation** - Export clean, optimized SQL for any PostgreSQL version (9.x to 17+) | ||||||
| ✅ **Professional Features** - Advanced relationships, triggers, functions, procedures, and more | ||||||
| ✅ **Active Development** - 19 years of continuous development and community support | ||||||
|
|
||||||
| ## 🚀 Quick Start | ||||||
|
|
||||||
| 1. **📥 Download** - Get pre-compiled packages from [pgmodeler.io](https://pgmodeler.io/purchase) | ||||||
| 2. **🎨 Design** - Create tables, relationships, and constraints visually | ||||||
| 3. **🔄 Sync** - Generate SQL or sync directly with your PostgreSQL server | ||||||
| 4. **🚀 Deploy** - Export optimized DDL scripts for production | ||||||
|
|
||||||
| > **💡 New User?** Check our [Video Tutorials](https://pgmodeler.io/support/tutorials) and [Documentation](https://pgmodeler.io/support/docs) | ||||||
|
|
||||||
| ## ⭐ Key Features | ||||||
|
|
||||||
| - **🎨 Visual Modeling** - Intuitive drag-and-drop interface for database design | ||||||
| - **🔄 Reverse Engineering** - Import and visualize existing PostgreSQL databases | ||||||
| - **⚡ Smart Diff** - Compare models with databases and generate migration scripts | ||||||
| - **🛠️ Code Generation** - Export clean SQL for any PostgreSQL version | ||||||
| - **🔍 Database Administration** - Built-in SQL editor and database browser | ||||||
| - **🔌 Plugin System** - Extend functionality with [official plugins](https://github.com/pgmodeler/plugins) | ||||||
| - **🌍 Multi-Platform Support** - Linux, Windows, and macOS compatibility | ||||||
| - **� Internationalization** - Multiple language support | ||||||
|
|
||||||
| ## 🏗️ Build Status | ||||||
|
|
||||||
| [](https://github.com/pgmodeler/pgmodeler/actions?query=workflow%3A%22Linux+build%22) | ||||||
| [](https://github.com/pgmodeler/pgmodeler/actions?query=workflow%3A%22Windows+build%22) | ||||||
| [](https://github.com/pgmodeler/pgmodeler/actions?query=workflow%3A%22macOs+build%22) | ||||||
|
|
||||||
| :rocket: What's pgModeler? | ||||||
| ------------ | ||||||
| ## 🌟 Community & Support | ||||||
|
|
||||||
| An **open-source, multiplatform database modeler for PostgreSQL**. This project aims to be a reference database design tool when it comes to FOSS in the PostgreSQL ecosystem. | ||||||
| Its feature-rich interface allows quick data modeling and fast code deployment on a server. It also supports reverse engineering by creating a visual representation of existing databases. Besides, pgModeler can also generate SQL scripts to sync a model and a database through the process called diff. | ||||||
| This tool is not about modeling only, it also counts with a minimalist but functional database server administration module that allows the execution of any sort of SQL commands, and provides database browsing and data handling in a simple and intuitive UI. | ||||||
| - 🐘 **PostgreSQL Ecosystem** - Official PostgreSQL community member | ||||||
| - 🌍 **Global Usage** - Used in enterprises, startups, and academia worldwide | ||||||
| - 📚 **Rich Documentation** - Comprehensive guides and tutorials | ||||||
| - 🔗 **Stay Connected** - Follow us on [X](https://x.com/pgmodeler), [Bluesky](https://bsky.app/profile/pgmodeler.io), [Mastodon](https://mastodon.social/@pgmodeler) | ||||||
|
|
||||||
| For more details about additional features, screenshots, and other useful information, please, visit the [project's official website](https://pgmodeler.io). For any feedback about the software visit the [Issues](https://github.com/pgmodeler/pgmodeler/issues) page. Additionally, follow pgModeler on [X](https://x.com/pgmodeler), [Bluesky](https://bsky.app/profile/pgmodeler.io) or [Mastodon](https://mastodon.social/@pgmodeler) and be up-to-date with new features, fixes, and releases. | ||||||
| **Need Help?** Visit our [Issues](https://github.com/pgmodeler/pgmodeler/issues) page or check the [official website](https://pgmodeler.io) for documentation and support. | ||||||
|
|
||||||
| :hammer_and_wrench: Building & Installing | ||||||
| ---------------------- | ||||||
| ## 🔧 Building & Installation | ||||||
|
|
||||||
| Being a multiplatform software, the building process differs slightly on each supported OS. This way, the installation procedures are fully described in the [Installation](https://www.pgmodeler.io/support/installation) section on the project's website. | ||||||
| Being a multiplatform software, the building process differs slightly on each supported OS. | ||||||
|
|
||||||
| You may want to check the [official plugin repository](https://github.com/pgmodeler/plugins) as well for information regarding extending pgModeler's features. | ||||||
| ### 📦 Pre-compiled Packages (Recommended) | ||||||
| - Download from [pgmodeler.io](https://pgmodeler.io/purchase) for instant setup | ||||||
| - Supports all major platforms with optimized builds | ||||||
|
|
||||||
| :spiral_notepad: Licensing | ||||||
| --------- | ||||||
| ### 🛠️ Build from Source | ||||||
| - Complete build instructions: [Installation Guide](https://www.pgmodeler.io/support/installation) | ||||||
| - Requirements: Qt 6.4+ (dropped 6.2/6.3 support), C++17 compiler, PostgreSQL client libraries | ||||||
| - Check the [official plugin repository](https://github.com/pgmodeler/plugins) for extending features | ||||||
|
|
||||||
| This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation version 3. | ||||||
| ## 💖 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! | ||||||
|
||||||
|
|
||||||
| ### 🎯 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! | ||||||
|
||||||
|
|
||||||
| :heart: pgModeler needs your support! | ||||||
| ------------------- | ||||||
| * 👨💻 **Developers Welcome** - Know C++ and Qt? We need your help! The project has grown beyond what a solo developer can handle. Contact us to contribute to this **high-quality C++ codebase**! | ||||||
|
|
||||||
| * 📢 **Spread the Word** - Share pgModeler in your networks, workplaces, and communities. The bigger our community, the stronger the project becomes! | ||||||
|
|
||||||
| [](https://github.com/sponsors/pgmodeler) | ||||||
| [](https://pgmodeler.io/#donationForm) | ||||||
|
|
||||||
| ## 🏆 Technical Excellence | ||||||
|
|
||||||
| ### 💎 **Crafted with Pride: Modern C++17 & Qt** | ||||||
| - **96.5% C++** codebase with **professional-grade architecture** | ||||||
|
||||||
| - **96.5% C++** codebase with **professional-grade architecture** | |
| - **Predominantly C++** codebase with **professional-grade architecture** |
Copilot
AI
Sep 7, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Suggested change
| **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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.