Skip to content

Add generated README to new projects#14

Merged
alexstyl merged 5 commits into
mainfrom
codex/generated-project-readme
Jun 23, 2026
Merged

Add generated README to new projects#14
alexstyl merged 5 commits into
mainfrom
codex/generated-project-readme

Conversation

@alexstyl

Copy link
Copy Markdown
Member

Summary

  • generate a root README.md for new projects created by the CLI
  • tailor the run instructions to the selected targets only
  • list the target instructions in the order JVM, Android, iOS, Wasm
  • cover the new README output in generator tests for JVM-only, Wasm-only, and full multi-target projects

Verification

  • ./gradlew test
  • ./gradlew integrationTest
  • ./gradlew run --args='create-app /tmp/composables-cli-readme-preview --package=com.example.preview --app-name=Preview --targets=jvm,android,ios,wasm --overwrite'
  • inspected /tmp/composables-cli-readme-preview/README.md

@alexstyl alexstyl merged commit 24152a7 into main Jun 23, 2026
1 check passed
@alexstyl alexstyl deleted the codex/generated-project-readme branch June 23, 2026 07:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant