Skip to content

Commit 40cd97a

Browse files
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

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,13 @@
66

77
## 🪄 Overview
88

9-
**DevAnalyzer** is a cross-platform desktop application built with **Compose Multiplatform** and **Kotlin Multiplatform (KMP)**. It provides deep insights into your **Android/Kotlin projects** and **local development environment** through two major modules:
9+
**DevAnalyzer** is a cross-platform desktop application built with **Compose Multiplatform** and **Kotlin Multiplatform (KMP)**.
1010

11-
- 🧩 **Project Analyzer**Inspects project modules, Gradle configurations, plugins, dependencies and related project files.
12-
- 💾 **Storage Analyzer**Inspects SDKs, IDEs, Gradle caches, and related storage usage on your machine.
11+
- 🧩 **Project Analyzer**Examines project modules, Gradle configurations, applied plugins, dependencies, and related build files.
12+
- 💾 **Storage Analyzer**Scans SDKs, IDE data, Gradle caches, and library directories to visualize overall storage usage.
1313

14-
This tool helps developers **understand**, **analyze**, and **optimize** their development ecosystem — all from a single unified interface.
15-
16-
This desktop-first tool runs seamlessly across platforms and can easily extend to Android, KMP, or backend Kotlin targets.
14+
Designed for modern developers, **DevAnalyzer** helps you **understand**, **analyze**, and **optimize** your entire development ecosystem — all from a single, unified interface.
15+
Built as a **desktop-first tool**, it runs seamlessly across platforms and can be easily extended to **Android**, **KMP**, or **backend Kotlin** environments.
1716

1817
---
1918

0 commit comments

Comments
 (0)