Add server instructions to README #1931
Conversation
|
👍 Awesome LGTM. Some more eyes on this and it will be merged, thanks for the update. |
There was a problem hiding this comment.
Thanks for this contribution and welcome to Lift!
The expectation when I reorganized this last was that folks would click through to the xsbt-web-plugin documentation and find instructions there. However, I can see that didn't quite go as I planned, so I think the right thing to do here is add some explicit guidance.
My one issue here is that the way things are ordered is a bit misleading. The instructions you've provided only apply to people using sbt instructions, but it appears below the maven instructions.
What do you think about creating two copies of this text at the bottom of each SBT section?
Bonus points if you're able to locate some corresponding instructions for starting the server from maven and add those as well.
Have added instructions on how to run the server in the latest version of Lift to the README.
kohrVid
force-pushed
the
add-server-instructions-to-readme
branch
from
396c837
to
9362cd9
Compare
|
Thank you both for the feedback. @farmdawgnation, I've moved the server instructions to the two SBT sections of the README like you suggested but I'm not very familiar with Maven and so was unable to find instructions for running the server that way. I hope that's ok. |
There was a problem hiding this comment.
@kohrVid I made a minor change to the header levels to avoid any possible confusion that the server sections "belong" to the sbt sections. other than that, this looks golden.
Thank you for this contribution!
Mailing List thread:
I thought it would be worth adding information on how to run the server to the README because the instructions I found in many of the tutorials and on the official website are out-of-date. I stumbled upon the above post in the mailing list by chance which contains the correct command for Lift v.3.