-
Notifications
You must be signed in to change notification settings - Fork 10.5k
Improve README: Add a notice to cd into swift directory before building Swift #16227
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.
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
Conversation
Added another "step" before someone tries to build swift so I can make the process easier for newbies.
@swift-ci please smoke test |
Hey Agis! Thanks for adding this. Just for a heads up, CI privileges are not granted automatically, but only after you’ve shown a track record of good contributions. With that, @swift-ci please smoke test |
Taking a closer look, it seems earlier in the directions, we |
@harlanhaskins I thought of that as well, but when it comes to documentation I "prefer" things to be dead simple. That's why I kept it like: One of the edge cases I thought was: What if someone closes the terminal window and needs to cd again in the swift directory, where the swift directory is gonna be found? Let me know if that makes sense or if it's complete nonsense and if I only think of such edge cases. 😂 |
Sorry for dropping this and picking it up just now. I'd like to think of the README as forming some sort of narrative, and we can assume that state changes like |
@harlanhaskins Ready for review. ⭐️ Thank you for the detailed comment! |
One last thing, before we merge, can you rebase your changes into one commit? We’d also prefer you not merge master back into your fork, and instead periodically rebase your fork onto master. It avoids the several merge commits. Once you do, I’ll run CI and merge! |
Let's just take this and squash it down. @swift-ci please smoke test |
⛵️ |
Thanks @CodaFi & @harlanhaskins. 🙌🏼 |
Another contributor had gone ahead and added the leading Swifts because this wasn't here. Just drop them again. Supersedes swiftlang#25211
[Gardening] Clean up after #16227
Today, I tried to build Swift for the first time and I had an issue. I couldn't build it because I was getting an error:
utils/build-script: No such file or directory
Then when I was talking with @harlanhaskins he said that I need to
cd
into the swift directory first.I didn't know that and I couldn't see that in the documentation. Even though for many experienced swift contributors that's something they know, for a newbie that's not the case.
With this PR I added a first step/ notice to the README file so newbies and first-time contributors like myself can have all the info that they need in front of them when they try to build Swift.