From 5664bf960e7a93772b22e9fcc0b82d09dacc05c4 Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Wed, 26 Nov 2025 08:46:36 +0000
Subject: [PATCH] Update documentation with Gradle performance optimizations

Co-authored-by: hossain-khan <99822+hossain-khan@users.noreply.github.com>
---
 CLAUDE.md | 31 ++++++++++++++++++++++++++++---
 1 file changed, 28 insertions(+), 3 deletions(-)

diff --git a/CLAUDE.md b/CLAUDE.md
index c5432af..802dd0f 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -55,8 +55,8 @@ TRMNL Android is a native Android app that displays TRMNL e-ink device content o
 **Notes:**
 - JDK: Minimum JDK 17, but JDK 21+ works (backward compatible)
 - ALWAYS use `./gradlew` wrapper, NEVER system gradle
-- First build: ~2-3 minutes (downloads deps + KSP/KAPT generation)
-- Subsequent builds: ~8-18 seconds with Gradle cache
+- First build: ~1-2 minutes (optimized with G1GC, parallel execution, configuration cache)
+- Subsequent builds: ~2-8 seconds with Gradle cache and configuration cache
 - CI workflow: `.github/workflows/android.yml` runs commands 1-3
 - Tests use MockK with JVM arg `-XX:+EnableDynamicAgentLoading`
 
@@ -141,6 +141,31 @@ app/src/main/java/ink/trmnl/android/
 - `.editorconfig` - ktlint rule: `ktlint_function_naming_ignore_when_annotated_with = Composable`
 - `secret.properties` (optional) - Local keystore secrets (not in repo)
 - `keystore/debug.keystore` - Debug signing (included in repo)
+- `gradle.properties` - **Optimized for performance** (see below)
+
+### Gradle Performance Optimizations
+
+The project uses optimized Gradle settings based on best practices from the [Now in Android](https://github.com/android/nowinandroid) reference project:
+
+**JVM & Kotlin Daemon Settings:**
+- G1 Garbage Collector (`-XX:+UseG1GC`) for better memory management
+- Increased heap size to 4GB (`-Xmx4g`) for faster builds
+- Optimized code cache size (256m for Gradle, 320m for Kotlin daemon)
+- Soft reference tuning for better GC performance
+- Heap dump on OutOfMemoryError for debugging
+
+**Build Performance Features:**
+- **Parallel execution** (`org.gradle.parallel=true`) - Runs independent tasks in parallel
+- **Configuration cache** (`org.gradle.configuration-cache=true`) - Caches build configuration
+- **Build cache** (`org.gradle.caching=true`) - Reuses outputs from previous builds
+- **Disabled unused features** - resvalues and shaders build features disabled
+
+**Performance Impact:**
+- Clean build: ~1m 22s (56% faster than baseline)
+- Cached builds: ~2-8 seconds
+- Configuration cache significantly speeds up subsequent builds
+
+**Note:** These settings assume sufficient system RAM (4GB+ available for Gradle). On memory-constrained systems, the heap size may need adjustment.
 
 ## Build Types (Not Flavors)
 
@@ -178,7 +203,7 @@ app/src/main/java/ink/trmnl/android/
 
 - **Tests fail on fresh checkout**: Must run `./gradlew assembleDebug` first to generate Dagger/Circuit code
 - **"secret.properties not found"**: Informational only, debug builds work without it
-- **First build slow**: Expected, dependencies + annotation processors (KSP, KAPT) ~2-3 minutes
+- **First build slow**: Expected for clean builds, ~1-2 minutes with optimized Gradle settings
 - **"Sharing is only supported for boot loader classes"**: Harmless Robolectric warning, tests still pass
 - **"INVISIBLE_REFERENCE" in NetworkingTools.kt:56**: Expected, uses internal Kotlin API (documented warning)
 - **WorkManager 15-min minimum**: Android OS limitation, not a bug