Skip to content

Update README.md to make it platform agnostic #839

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 8, 2024
Merged

Update README.md to make it platform agnostic #839

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e54731
Update README.md
0xTim Oct 5, 2024
69ad898
Update README.md
0xTim Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@ For example, if you are using Xcode 13.3 (Swift 5.6), you will need
If you are mainly interested in using swift-format (rather than developing it),
then you can get it in three different ways:

### Included in Xcode
### Included in the Swift Toolchain

Xcode 16 and above include swift-format in the toolchain. You can run `swift-format` from anywhere on the system using `swift format` (notice the space instead of dash). To find the path at which `swift-format` is installed, run `xcrun --find swift-format`.
Swift 6 (included with Xcode 16) and above include swift-format in the toolchain. You can run `swift-format` from anywhere on the system using `swift format` (notice the space instead of dash). To find the path at which `swift-format` is installed on macOS, run `xcrun --find swift-format`.
Copy link
Member

Choose a reason for hiding this comment

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

"on macOS" might be better expressed as "in Xcode".

@ahoppen Thoughts on wording here from Apple's end?

Copy link
Contributor

Choose a reason for hiding this comment

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

Is the last sentence needed if the section is now generically "in the Swift Toolchain"?

Copy link
Member

Choose a reason for hiding this comment

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

I think we should keep it because usually people don’t know the path of the toolchain inside Xcode. And I agree that in Xcode makes more sense.

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated!


### Installing via Homebrew

Expand Down