Skip to content

Update README.md to add more info and fix typos, fix generator help / output - #275

Merged
MaxDesiatov merged 7 commits into
swiftlang:mainfrom
swift-embedded-linux:feature/update-readme-and-output
Sep 30, 2026
Merged

MaxDesiatov merged 7 commits into
swiftlang:mainfrom
swift-embedded-linux:feature/update-readme-and-output

Conversation

@xtremekforever

@xtremekforever xtremekforever commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

README.md changes:

  • Added a new section for Linux Requirements, which is something I ran into when running the swift-sdk-generator on a new Linux install.
  • Fixed Markdown linter errors, typos, and grammatical errors across the whole document.
  • Removed experimental- prefix from sample commands since now the generator requires Swift 6.0 or higher.
  • Changed wording in the document to note that Ubuntu Noble is default, 6.0 or higher is required to run the generator.

Minor code changes:

  • Added Debian 13 in the help output in GeneratorCLI.swift.
  • Removed experimental- prefix from generator help output in SwiftSDKGenerator+Entrypoint.swift

Comment thread README.md Outdated

@MaxDesiatov MaxDesiatov left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Overall LGTM, thank you! Only thing I'm unsure about is the QEMU dependency mentioned in the diff. Can we remove it for now so that it isn't a point of contention in this PR specifically? Then it could be addressed separately.

@xtremekforever
xtremekforever force-pushed the feature/update-readme-and-output branch from e1c6c30 to 4a28caf Compare September 29, 2026 17:12
@xtremekforever

Copy link
Copy Markdown
Contributor Author

Overall LGTM, thank you! Only thing I'm unsure about is the QEMU dependency mentioned in the diff. Can we remove it for now so that it isn't a point of contention in this PR specifically? Then it could be addressed separately.

The qemu section was removed. I'll open a ticket to look at improving container runtime support separately.

@MaxDesiatov

Copy link
Copy Markdown
Contributor

@swift-ci test

@MaxDesiatov
MaxDesiatov enabled auto-merge (squash) September 29, 2026 21:35
@MaxDesiatov
MaxDesiatov merged commit 18a4252 into swiftlang:main Sep 30, 2026
44 checks passed
@xtremekforever
xtremekforever deleted the feature/update-readme-and-output branch September 30, 2026 01:51
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.

2 participants