How to Develop

You can test the plugin by building it and publishing it to Maven Local, then referencing it from the sample Android app. Just follow these steps:

1. Clone this project

Start by cloning the repository to your local machine:

git clone <repository-url>
cd <repository-directory>

Build the sample Android app to test the plugin:

./gradlew :sample:assembleDebug

JSON files are generated because schema output is enabled with androidx.room.

Run the task to generate ER diagrams and documentation from the Room schema:

./gradlew :sample:generateRoomSchemaDocs

Based on the JSON files created in step 3, a Markdown file with a Mermaid ER diagram is generated.

Contributions are always welcome!