Run the setup script to automatically handle most of the configuration:

Script Usage:

./setup-project.sh <package-name> <AppName> [flags]

Parameters:

• <package-name> - Your app's package name in reverse domain notation (e.g., com.mycompany.appname)
• <AppName> - Your app's class name in PascalCase (e.g., TodoApp, NewsApp, MyPhotos)
  • Used to rename CircuitApp → {AppName}App
  • Becomes your main Application class name
  • Sets app display name in strings.xml
  • Used in git commit messages

Examples:

# Basic usage - keeps examples and WorkManager by default
./setup-project.sh com.mycompany.appname MyAppName
# Remove WorkManager if you don't need background tasks
./setup-project.sh com.mycompany.appname MyAppName --remove-workmanager
# Keep the script for debugging (useful during development)
./setup-project.sh com.mycompany.appname MyAppName --keep-script

What the script does automatically:

• Renames package from app.example to your preferred package name
• Preserves subdirectory structure (ui/theme/, di/, circuit/, work/, data/)
• Updates app name and package ID in XML and Gradle files
• Renames CircuitApp to YourAppNameApp
• Keeps WorkManager files by default (use --remove-workmanager to exclude)
• Creates a fresh git repository with descriptive initial commit
• Removes template-specific files

If you prefer manual control, complete these tasks:

• Rename the package from app.example to your preferred app package name.
• Update directory structure based on package name update
• Update app name and package id in XML and Gradle
• Rename CircuitApp*** to preferred file names
• Remove Example*** files that were added to showcase example usage of app and Circuit.
• Remove WorkManager and Worker example files if you are not using them.

These still need to be done manually after using the script:

• Update .editorconfig based on your project preference
• Update your app theme colors (use Theme Builder )
• Generate your app icon (use Icon Kitchen )
• Update/remove repository license
• Configure renovate for dependency management or remove renovate.json file
• Choose Google font for your app, or remove it.
• Verify Android Gradle Plugin (AGP) version compatibility with your development environment in gradle/libs.versions.toml