Skip to content
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

Add installation instructions to the generated README #47

Open
JohnSundell opened this issue Apr 3, 2017 · 4 comments
Open

Add installation instructions to the generated README #47

JohnSundell opened this issue Apr 3, 2017 · 4 comments

Comments

@JohnSundell
Copy link
Owner

As suggested by @krzysztofzablocki on Twitter, it would be great if the README file that SwiftPlate generates would contain instructions on how to install the generated framework using CocoaPods, Carthage and the Swift Package Manager.

@agisilaos
Copy link

Hey @JohnSundell I would love to start working on that Issue! Can you give me some more info about it?

@JohnSundell
Copy link
Owner Author

Happy to hear that @agisilaos 🎉

OK, so what I would suggest is to look at for example Wrap (https://github.com/johnsundell/wrap), and make SwiftPlate generate a similar Installation section in the README file it generates. Basically modify the template here: https://github.com/JohnSundell/SwiftPlate/blob/master/Template/README.md.

@agisilaos
Copy link

@JohnSundell Yup, got it! Makes sense! ☺️

@agisilaos
Copy link

Just made this pull request #49 for this specific issue. Let me know what you think @JohnSundell :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants