-
Notifications
You must be signed in to change notification settings - Fork 31
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
README.md should describe run commands #16
Comments
Excellent idea. First Draft: https://github.com/scala-native/sbt-cross-example |
Thanks for your feedback! More doc improvement here: https://github.com/MasseGuillaume/sbt-cross-project/tree/better-doc#cross-platform-compilation-support-for-sbt |
@MasseGuillaume, thank you for paying attention to this issue.
I hope some of this is useful, if only to show that someone is |
Please consider having the README.md describe the run commands for
cross projects.
It has been a long while since I have used an sbt multi-project. The simple
'''sbt run'' in my mind from just having finished the
sbt-native tutorial did not work.
I was in the midst of figuring out the required commands for sbt-cross the hard way
when I came across the scalajs-cross tutorial and rejoiced. Adapting freely from that tutorial (I think I am OK with copyright/license here)
'''
sbt> barJS/run
sbt> barJVM/run
sbt> barNative/run
'''
This addition would get the README.md closer to a "Getting started: see one, do one" state.
Agreed that post-introductory work requires a deeper understanding of sbt, scala-native, &
scala-cross.
Thank you for considering this suggestion.
Lee
The text was updated successfully, but these errors were encountered: