Update README.md #2212
Merged
Update README.md #2212
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@swift-ci Please test |
kimdv
approved these changes
Sep 18, 2023
bnbarham
approved these changes
Sep 18, 2023
Matejkob
reviewed
Sep 18, 2023
Examples/README.md
Outdated
| @@ -5,6 +5,7 @@ Each example can be executed by navigating into this folder and running `swift r | |||
| - [AddOneToIntegerLiterals](Sources/AddOneToIntegerLiterals/AddOneToIntegerLiterals.swift): Command line tool to add 1 to every integer literal in a source file | |||
| - [CodeGenerationUsingSwiftSyntaxBuilder](Sources/CodeGenerationUsingSwiftSyntaxBuilder/CodeGenerationUsingSwiftSyntaxBuilder.swift): Code-generate a simple source file using SwiftSyntaxBuilder | |||
| - [ExamplePlugin](Sources/ExamplePlugin): Compiler plugin executable using [`SwiftCompilerPlugin`](../Sources/SwiftCompilerPlugin) | |||
| - [MacroExamples](Sources/MacroExampls): A collection of Swift macros | |||
|
|
||
| ## Documentation | ||
|
|
||
| You can read SwiftSyntax’s documentation on [swiftpackageindex.com](https://swiftpackageindex.com/apple/swift-syntax/documentation). | ||
|
|
||
| A great way to interactively explore the SwiftSyntax tree of a source file is https://swift-ast-explorer.com, developed by [@kishikawakatsumi](https://github.com/kishikawakatsumi). | ||
|
|
||
| ## Adding SwiftSyntax as a Dependency | ||
| A set of example usages of swift-syntax can be found in [Examples](Examples). |
There was a problem hiding this comment.
With Swift 5.9 out, lots of folks are looking to get their hands dirty with Swift macros.
How about we jazz up the README to spotlight our Macro examples? We could go with something like:
Suggested change
| A set of example usages of swift-syntax can be found in [Examples](Examples). | |
| A variety of example usages of swift-syntax are available in the [Examples](Examples) directory, including a collection of [Swift macros](Examples/Sources/MacroExampls). |
What do you think? 🤔
There was a problem hiding this comment.
I would like to see the macro examples cleaned up a little bit before giving them a top-level highlight in the README.md first.
There was a problem hiding this comment.
Do you have any areas in mind that could be improved in the macro examples not mentioned in #2169?
There was a problem hiding this comment.
No, I basically meant the first two open points in #2169
- Make implementations of all macros consistent
- Change nodes modification to use variable setters instead of
withapproach
And maybe adding some more comments that explain what’s being done, not sure how much of those would be needed.
ahoppen
force-pushed
the
ahoppen/update-readme
branch
from
3d3f879
to
5046cb4
Compare
README.md hasn’t really been re-visited in a while and contained a lot of outdated information. Shorten it a little bit.
ahoppen
force-pushed
the
ahoppen/update-readme
branch
from
5046cb4
to
dd02513
Compare
|
@swift-ci Please test |
1 similar comment
|
@swift-ci Please test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
README.md hasn’t really been re-visited in a while and contained a lot of outdated information. Shorten it a little bit.