Skip to content

Commit 1245683

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 b9c6088 commit 1245683

27 files changed

+131
-130
lines changed

README.md

Lines changed: 131 additions & 130 deletions
Original file line numberDiff line numberDiff line change
@@ -1,183 +1,184 @@
11
# 🧠 DevAnalyzer
22

3-
### Cross-Platform Development Analyzer Suite (Compose Multiplatform Desktop)
3+
[![DevAnalyzer](screenshot/dev_analyzer.png)]()
44

55
---
66

7-
## 📖 Overview
7+
## 🪄 Overview
88

9-
**DevAnalyzer** is a **Compose Multiplatform Desktop App** built with **Kotlin Multiplatform (KMP)**
10-
that helps developers analyze their entire development environment. It brings deep insights into
11-
both **project structure** and **system storage** used by Android, Kotlin, and backend development
12-
setups.
9+
**DevAnalyzer** is a cross-platform desktop application built with **Compose Multiplatform** and *
10+
*Kotlin Multiplatform (KMP)**.
11+
It provides deep insights into your **Android/Kotlin projects** and **local development environment
12+
** through two major modules:
1313

14-
It includes two core modules:
15-
16-
* **Project Analyzer** → Scans and analyzes project configuration, Gradle modules, plugins, and
17-
dependencies.
18-
* **Storage Analyzer** → Inspects SDKs, IDEs, Gradle caches, and related storage usage on your
14+
- 🧩 **Project Analyzer** — Inspects project modules, Gradle configurations, plugins, dependencies
15+
and related project files.
16+
- 💾 **Storage Analyzer** — Inspects SDKs, IDEs, Gradle caches, and related storage usage on your
1917
machine.
2018

19+
This tool helps developers **understand**, **analyze**, and **optimize** their development
20+
ecosystem — all from a single unified interface.
21+
2122
This desktop-first tool runs seamlessly across platforms and can easily extend to Android, KMP, or
2223
backend Kotlin targets.
2324

2425
---
2526

26-
## ⚙️ Features
27-
28-
### 🧩 **Project Analyzer**
27+
## 🚀 Features
2928

30-
Gain full insight into your project structure and Gradle configuration.
29+
### 🧩 Project Analyzer
3130

32-
* 🔍 Analyze Gradle modules, dependencies, and build scripts.
33-
* 📦 List all applied plugins and version catalogs.
34-
* 🧱 Inspect configuration data (Min SDK, Target SDK, Kotlin/AGP versions).
35-
* 🧾 Browse and preview Gradle and project files directly.
31+
- 🔍 Analyze **Gradle modules**, **plugins**, and **dependencies**.
32+
- 📦 List all applied plugins and version catalogs.
33+
- 📄 View **build files** and configuration scripts in an organized manner.
34+
- 🧱 Inspect project metadata such as Gradle Kotlin, AGP, Min SDK, Compile SDK, Target SDK and
35+
Multi-Module.
36+
- 🧾 Preview all **project and Gradle files** directly in the app.
3637

37-
### 💾 **Storage Analyzer**
38+
### 💾 Storage Analyzer
3839

39-
Visualize your development storage usage across tools.
40-
41-
* 📊 Scan SDKs, IDE data, NDK, CMake, and Extras.
42-
* 🧠 Inspect Gradle daemons, wrappers, and caches.
43-
* 🧩 Analyze Kotlin/Native, LLVM, and JDK installations.
44-
* 💡 Identify heavy directories and potential cleanup targets.
40+
- 💡Get total storage summaries by component (SDK, IDE, Gradle, Library, etc.).
41+
- 📊 Scan **SDK**, **NDK**, **CMake**, **Kotlin/Native**, **JDK** and **Extras** directories.
42+
- 📄 Analyze **IDE data** (Android Studio, IntelliJ) including logs, caches, and support files.
43+
- 🧠 Inspect **Gradle Daemons**, **Wrappers**, and **Cached Libraries**.
4544

4645
---
4746

48-
## 🧭 **Navigation Structure**
47+
## 🧰 Tech Stack
4948

50-
| Section | Purpose |
51-
|---------------------|----------------------------------------------------------------|
52-
| 🔍 **Project** | Analyze project modules, dependencies, and Gradle build setup. |
53-
| 💾 **Storage** | Analyze IDE, SDK, and Gradle storage usage. |
54-
| 🌞 **Theme Switch** | Toggle light/dark theme from the sidebar footer. |
49+
| Category | Libraries & Tools |
50+
|-----------|-------------------------------------------------------------------------|
51+
| **Framework** | Compose Multiplatform |
52+
| **Language** | Kotlin 2.x (Multiplatform) |
53+
| **Architecture** | MVVM |
54+
| **Design System** | Material 3 with Adaptive Navigation Suite |
55+
| **Dependency Injection** | Koin |
56+
| **Navigation** | Jetpack Navigation for Compose |
57+
| **Image Loading** | Coil3 (Compose + Ktor + Multiplatform) |
58+
| **Local Storage** | DataStore (Core + Preferences) |
59+
| **Serialization** | kotlinx.serialization |
60+
| **Logging** | Kermit (TouchLab Multiplatform Logger) |
61+
| **File Handling** | FileKit (Dialogs + Compose) |
62+
| **Theme Detection** | JSystemThemeDetector |
63+
| **Semantic Versioning** | SemVer (z4kn4fein/semver) |
64+
| **Coroutines** | kotlinx.coroutines + Swing Dispatcher (Desktop) |
5565

56-
## 🧰 **Tech Stack**
66+
## 🖥️ How to Run DevAnalyzer
5767

58-
| Layer | Technology |
59-
|----------------------|--------------------------------------------------|
60-
| **UI** | Compose Multiplatform (Desktop, Android) |
61-
| **Language** | Kotlin 2.x (Multiplatform) |
62-
| **Architecture** | Modular Analyzer System (Enum-based UI Model) |
63-
| **Design System** | Material 3 (Compose for Desktop) |
64-
| **Build Tool** | Gradle KMP DSL |
65-
| **Platform Support** | Desktop ✅ · Android ✅ · KMP ✅ · Backend Kotlin ✅ |
68+
After downloading the latest release from
69+
the [Releases](https://github.com/Coding-Meet/DevAnalyzer/releases) page, follow the steps based on
70+
your operating system.
6671

67-
---
68-
69-
## 🧠 **Key Highlights**
70-
71-
* 🧩 Compose Multiplatform Desktop UI using Material 3.
72-
* ⚙️ Works across JVM and native KMP targets.
73-
* 📊 Unified analysis for both project and environment.
74-
* 💡 Lightweight, modular, and easy to extend.
75-
* 🧱 Enum-driven architecture for consistent, dynamic UI.
76-
77-
---
72+
### Windows
7873

79-
## 💻 **Setup & Run Instructions**
74+
1. Download the `.msi` installer from the Assets section.
75+
2. Double-click the file and follow the setup instructions.
76+
3. Once installed, you can launch DevAnalyzer from the Start menu.
8077

81-
### 🧩 **Requirements**
78+
### macOS
8279

83-
* Kotlin 2.x or later
84-
* Gradle 8.x+
85-
* JDK 17+
86-
* Compose Multiplatform plugin enabled in IDE (IntelliJ IDEA recommended)
80+
1. Download the `.dmg` file from the Assets section.
81+
2. Double-click it to open, then drag DevAnalyzer to the Applications folder.
82+
3. The first time you open the app, macOS might show a warning:
8783

88-
### ▶️ **Run the Desktop App**
84+
> “DevAnalyzer can’t be opened because it is from an unidentified developer.”
8985
90-
```bash
91-
git clone https://github.com/Coding-Meet/DevAnalyzer.git
92-
cd DevAnalyzer
93-
./gradlew run
94-
```
86+
To fix this:
9587

96-
### 🧪 **Build Executable (Desktop)**
88+
1. Open **System Settings → Privacy & Security**
89+
2. Scroll down to **Security**
90+
3. Click **Allow Anyway** next to “DevAnalyzer”
91+
4. Reopen the app — it will launch successfully.
9792

98-
```bash
99-
./gradlew packageDistributionForCurrentOS
100-
```
93+
> macOS sometimes blocks unsigned apps for security reasons. Once allowed from Privacy & Security,
94+
the app will work normally.
10195

102-
This will generate a platform-specific build under `build/compose/binaries`.
96+
### Linux (Ubuntu/Debian)
10397

104-
---
98+
1. Download the `.deb` package from the Assets section.
99+
2. Open a terminal in the download directory and run:
100+
```shell
101+
sudo dpkg -i devanalyzer_1.0.0-1_amd64.deb
102+
```
103+
3. After installation, you can launch the app from your system menu or by running:
104+
```shell
105+
devanalyzer
106+
```
105107

106-
## 🧩 **Future Enhancements**
108+
### Run from Source (Development Mode)
107109

108-
* 🧹 Environment cleanup tools (safe Gradle/IDE cache removal)
109-
* 📊 Interactive graphs for dependencies and storage usage
110-
* 🔄 Real-time analysis & background scanning
111-
* ☁️ Sync analyzer reports with CodingMeet Cloud
112-
* 🧱 Plugin API for custom analyzers
110+
If you want to build and run the app from source:
113111

114-
---
112+
**macOS/Linux**
115113

116-
## 🏷️ **Project Info**
114+
```shell
115+
./gradlew :composeApp:run
116+
```
117117

118-
* **Name:** DevAnalyzer
119-
* **Version:** 1.0.0 (Beta)
120-
* **Developer:** Meet Bhavsar ([Coding Meet](https://codingmeet.com))
121-
* **Type:** Compose Multiplatform Desktop App
122-
* **Website:** [codingmeet.com/devanalyzer](https://codingmeet.com)
123-
* **License:** MIT
118+
**Windows**
124119

120+
```shell
121+
.\gradlew.bat :composeApp:run
122+
```
125123
---
126124

127-
### 🧡 **Developed with passion by [Coding Meet](https://codingmeet.com)**
128-
129-
# Project Analyzer
125+
## Contributing 🤝
130126

131-
Project Analyzer is a powerful tool for Android developers to gain insights into their projects and
132-
manage their development environment's storage. It provides a detailed breakdown of your project's
133-
structure and analyzes storage consumption by various components like IDEs, SDKs, Gradle, and more.
127+
Contributions, issues, and feature suggestions are always welcome! 🙌
128+
If you have ideas to make DevAnalyzer better, feel free to open a pull request or start a
129+
discussion.
134130

135-
## Features
131+
## ❤ Show your support
136132

137-
### Project Analysis
133+
Give a ⭐️ if this project helped you!
138134

139-
- **Overview**: Get a high-level overview of your project.
140-
- **Modules**: Explore the different modules in your project.
141-
- **Plugins**: See a list of all plugins used in the project.
142-
- **Dependencies**: Analyze the project's dependencies.
143-
- **Build Files**: Inspect the build files of the project.
144-
- **Project Files**: Browse through the project files.
135+
<a href="https://www.buymeacoffee.com/codingmeet" target="_blank">
136+
<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" width="160">
137+
</a>
145138

146-
🧠 Development Storage Analyzer
139+
Your generosity is greatly appreciated! Thank you for supporting this project.
147140

148-
📖 Overview
141+
## Connect with me
149142

150-
Development Storage Analyzer is a powerful tool designed to scan, analyze, and visualize storage
151-
usage across key components of your Android development environment.
152-
It helps developers understand how much space is consumed by SDKs, IDEs, Gradle, AVDs,
153-
Kotlin/Native, JDKs, and cached libraries — all in one organized dashboard.
143+
[![](https://img.shields.io/badge/Youtube-red?style=for-the-badge&logo=youtube&logoColor=white)](https://youtube.com/@CodingMeet26?si=FuKwU-aBaf_5kukR)
144+
[![](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/coding-meet/)
145+
[![](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/CodingMeet)
154146

155-
This feature provides a clear, expandable view of storage data with summaries, totals, and
156-
categorized insights, helping developers clean up or optimize their workspace effectively.
147+
## Author
157148

158-
⚡ Key Highlights
149+
**Meet**
159150

160-
- 🔍 Deep Environment Scanning – Analyzes Android Studio, IntelliJ, SDK, AVD, Gradle, and toolchain
161-
folders.
162-
- 📊 Categorized Insights – Displays detailed breakdowns per tool (IDE, SDK, Gradle, Libraries,
163-
etc.).
164-
- 💾 Readable Storage Summaries – Converts raw sizes into human-friendly units (e.g., MB, GB).
165-
- 🧩 Expandable Sections – Every category includes a collapsible section showing totals and detailed
166-
file paths.
167-
- ⚙️ Cross-Platform Support – Works across macOS, Windows, and Linux development environments.
168-
- 🧱 Built for Developers – Provides direct paths and real folder structures for informed cleanup or
169-
debugging.
170-
- 🎨 Material 3 UI + Compose Design – Clean, modern interface consistent with Android development
171-
tools.
172-
173-
🧭 Tab Overview
151+
---
174152

175-
| Tab | Description |
176-
|---------------------|---------------------------------------------------------------------------------------------|
177-
| Overview | Displays total storage usage and category-wise breakdown (IDE, SDK, Gradle, etc.) |
178-
| IDE | Analyzes IDE installations (Android Studio, IntelliJ) with caches, logs, and support files. |
179-
| AVD & System Images | Lists configured Android Virtual Devices and downloaded system images. |
180-
| Android SDK | Breaks down SDK Platforms, Build Tools, NDK, CMake, Sources, and Extras. |
181-
| Kotlin/Native & JDK | Displays installed JDK versions, Kotlin/Native toolchains, and LLVM/LLDB dependencies. |
182-
| Gradle | Analyzes Gradle Daemons, Wrappers, Caches, and additional Gradle directories. |
183-
| Libraries | Lists downloaded Gradle libraries with versions, group names, and storage usage. |
153+
## Screenshots
154+
155+
### Development Project Analyzer Feature
156+
157+
![Development Project Analyzer Screenshot](screenshot/project/img.png)
158+
![Development Project Analyzer Screenshot](screenshot/project/img_1.png)
159+
![Development Project Analyzer Screenshot](screenshot/project/img_2.png)
160+
![Development Project Analyzer Screenshot](screenshot/project/img_3.png)
161+
![Development Project Analyzer Screenshot](screenshot/project/img_4.png)
162+
![Development Project Analyzer Screenshot](screenshot/project/img_5.png)
163+
164+
### Development Storage Analyzer Feature
165+
166+
![Development Storage Analyzer Screenshot](screenshot/storage/img.png)
167+
![Development Storage Analyzer Screenshot](screenshot/storage/img_1.png)
168+
![Development Storage Analyzer Screenshot](screenshot/storage/img_2.png)
169+
![Development Storage Analyzer Screenshot](screenshot/storage/img_3.png)
170+
![Development Storage Analyzer Screenshot](screenshot/storage/img_4.png)
171+
![Development Storage Analyzer Screenshot](screenshot/storage/img_5.png)
172+
![Development Storage Analyzer Screenshot](screenshot/storage/img_6.png)
173+
![Development Storage Analyzer Screenshot](screenshot/storage/img_7.png)
174+
![Development Storage Analyzer Screenshot](screenshot/storage/img_8.png)
175+
![Development Storage Analyzer Screenshot](screenshot/storage/img_9.png)
176+
![Development Storage Analyzer Screenshot](screenshot/storage/img_10.png)
177+
![Development Storage Analyzer Screenshot](screenshot/storage/img_11.png)
178+
![Development Storage Analyzer Screenshot](screenshot/storage/img_12.png)
179+
![Development Storage Analyzer Screenshot](screenshot/storage/img_13.png)
180+
![Development Storage Analyzer Screenshot](screenshot/storage/img_14.png)
181+
![Development Storage Analyzer Screenshot](screenshot/storage/img_15.png)
182+
![Development Storage Analyzer Screenshot](screenshot/storage/img_16.png)
183+
![Development Storage Analyzer Screenshot](screenshot/storage/img_17.png)
184+
![Development Storage Analyzer Screenshot](screenshot/storage/img_18.png)

screenshot/dev_analyzer.png

446 KB
Loading

screenshot/project/img.png

145 KB
Loading

screenshot/project/img_1.png

168 KB
Loading

screenshot/project/img_2.png

192 KB
Loading

screenshot/project/img_3.png

190 KB
Loading

screenshot/project/img_4.png

203 KB
Loading

screenshot/project/img_5.png

214 KB
Loading

screenshot/storage/img.png

167 KB
Loading

screenshot/storage/img_1.png

174 KB
Loading

0 commit comments

Comments
 (0)