crkl/.notes/directory_structure.md
ilia c351858749 Update project configuration files and enhance documentation
- Updated `.gitignore` and `.cursorignore` to exclude additional build artifacts and temporary files.
- Enhanced `.cursorrules` with comprehensive AI guidelines and best practices.
- Improved `.notes/directory_structure.md` to reflect the current project structure and module organization.
- Updated `ARCHITECTURE.md` to include new insights on the system's modular design and privacy-first approach.
- Refined `README.md` for clarity on project setup and usage instructions.
- Added new entries in `.notes/meeting_notes.md` to document recent progress and decisions.
- Ensured all changes align with the project's privacy and security standards.
2025-10-18 14:32:33 -04:00

1.2 KiB

Directory Structure

/app/src/main/kotlin/com/example/crkl/ /accessibility/ # Accessibility overlay and services # - CrklAccessibilityService.kt (main service) # - OverlayView.kt (touch capture overlay) /gesture/ # Gesture tracking, region extraction (TODO) /model/ # STT/LLM wrappers, inference runners (TODO) /vision/ # Content classification and ML components (TODO) /agent/ # Dialogue state management (TODO) /ui/ # Jetpack Compose overlays and feedback UIs # - theme/ (Theme.kt, Type.kt) /privacy/ # Data/cache handling, controls (TODO) MainActivity.kt # Main activity for settings/permissions

/app/src/main/res/ /values/ # strings.xml, colors.xml, themes.xml /xml/ # accessibility_service_config.xml /mipmap-*/ # App launcher icons

/app/src/test/ # Unit tests (TODO) /app/src/androidTest/ # Android instrumentation tests (TODO)

/tests/ # Additional test utilities

Root config files:

  • build.gradle.kts (root)
  • settings.gradle.kts
  • gradle.properties
  • local.properties
  • app/build.gradle.kts