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

update README.md for testing and release mvn commands #306

Open
stevehu opened this issue May 21, 2019 · 1 comment
Open

update README.md for testing and release mvn commands #306

stevehu opened this issue May 21, 2019 · 1 comment

Comments

@stevehu
Copy link
Contributor

stevehu commented May 21, 2019

For normal testing, there is no need to build src.jar and doc.jar as well as the fat.jar as they take a lot of time. You can just run mvn clean install exec:exec to start the server. When you are planning to release, you can run mvn clean install -Prelease to build all artifacts.

The above information should be in the README.md of each generated project.

@stevehu
Copy link
Contributor Author

stevehu commented May 21, 2019

Need more information in the README.md to guide users on how to start the project from the scaffolded project. Possible linking to some documents or videos.

How to run unit test, integration test. How to start the server in test mode. How to release the server. How to enable some of the handlers etc.

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

No branches or pull requests

1 participant