Skip to content

Add logic to write platform specific README in native package scaffolding#27

Merged
1egoman merged 1 commit intomainfrom
add-platform-package-readme
Feb 6, 2026
Merged

Add logic to write platform specific README in native package scaffolding#27
1egoman merged 1 commit intomainfrom
add-platform-package-readme

Conversation

@1egoman
Copy link
Collaborator

@1egoman 1egoman commented Feb 6, 2026

No description provided.

Comment on lines +20 to +24
/// The value of the "name" field in the main package's "package.json". Used to add context to
/// the README.md about the purpose of the package.
#[arg(long, default_value = None)]
lib_package_name: Option<String>,

Copy link
Collaborator Author

@1egoman 1egoman Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made this optional because I think there are situations where the parent package may not be clear at build time / it may not make sense to include it in the readme. Making this required also then breaks the nice <lib source> <triple> required args pattern which makes getting started slower.

@1egoman 1egoman merged commit 9faabc2 into main Feb 6, 2026
3 checks passed
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