Skip to content

Commit 959e186

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 1245683 commit 959e186

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ backend Kotlin targets.
3737

3838
### 💾 Storage Analyzer
3939

40-
- 💡Get total storage summaries by component (SDK, IDE, Gradle, Library, etc.).
40+
- 💡 Get total storage summaries by component (SDK, IDE, Gradle, Library, etc.).
4141
- 📊 Scan **SDK**, **NDK**, **CMake**, **Kotlin/Native**, **JDK** and **Extras** directories.
4242
- 📄 Analyze **IDE data** (Android Studio, IntelliJ) including logs, caches, and support files.
4343
- 🧠 Inspect **Gradle Daemons**, **Wrappers**, and **Cached Libraries**.
@@ -91,7 +91,7 @@ To fix this:
9191
4. Reopen the app — it will launch successfully.
9292

9393
> macOS sometimes blocks unsigned apps for security reasons. Once allowed from Privacy & Security,
94-
the app will work normally.
94+
> the app will work normally.
9595
9696
### Linux (Ubuntu/Debian)
9797

0 commit comments

Comments
 (0)