Commit 40cd97a
committed
docs: Overhaul and redesign README
This commit completely rewrites and restructures the `README.md` file to enhance clarity, improve organization, and provide comprehensive information for both users and contributors.
The new design focuses on a more professional and engaging presentation, making it easier to understand the project's purpose, features, and setup instructions.
### Key Changes:
* **Header and Overview:**
* Added a new banner image for better visual appeal.
* Rewrote the overview to be more concise and impactful, clearly defining the "Project Analyzer" and "Storage Analyzer" modules.
* **Features Section:**
* Reformatted features into a more scannable, emoji-enhanced list for both Project and Storage analyzers, improving readability.
* **New "How to Run" Section:**
* Added detailed, user-friendly instructions for installing and running the application on Windows, macOS, and Linux using the packaged distributions (`.msi`, `.dmg`, `.deb`).
* Includes specific guidance for handling macOS security warnings for unsigned applications.
* Provides updated commands to run the app from source (`./gradlew :composeApp:run`).
* **Tech Stack:**
* Replaced the high-level tech stack overview with a detailed table listing specific libraries and tools used for DI, navigation, image loading, serialization, etc.
* **Screenshots:**
* Added an extensive "Screenshots" section with numerous images showcasing the UI for both the Project and Storage Analyzer features.
* **Community and Support:**
* Introduced new sections for "Contributing," "Show your support" (with a "Buy Me a Coffee" button), and "Connect with me" social links.
* **Content Removal:**
* Removed outdated and redundant sections, such as "Navigation Structure," "Key Highlights," and duplicated feature descriptions.
* Removed the "Future Enhancements" and "Project Info" sections to streamline the content.1 parent b5d4234 commit 40cd97a
1 file changed
+5
-6
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | | - | |
12 | | - | |
| 11 | + | |
| 12 | + | |
13 | 13 | | |
14 | | - | |
15 | | - | |
16 | | - | |
| 14 | + | |
| 15 | + | |
17 | 16 | | |
18 | 17 | | |
19 | 18 | | |
| |||
0 commit comments