vertx-starter icon indicating copy to clipboard operation
vertx-starter copied to clipboard

Published 20 hours ago • verified publisher icon pmlopes

create a README template

Open pmlopes opened this issue 7 years ago • 3 comments

Create a README template and apply the notes from https://github.com/pmlopes/vertx-starter/issues/21#issuecomment-428349737

pmlopes avatar Oct 10 '18 06:10 pmlopes

The readme could be also applied to preset apps so more specific info could be given to users, for example:

  • run npm install/webapack etc...
  • openapi generator does not validate specs, be aware!
  • etc...

pmlopes avatar Oct 16 '18 07:10 pmlopes

IMHO for #21 we should add some templates to web related presets, while for #28 we should add documentation for presets as md in github (or maybe inside the app itself), as i did here: https://github.com/pmlopes/vertx-starter/pull/27/files#diff-9d1b33e331c898b8c32d5d3d4b1e6c6b

slinkydeveloper avatar Oct 16 '18 12:10 slinkydeveloper

See an example here: https://github.com/hantsy/helidon-sample/blob/master/quickstart-se/README.md

pmlopes avatar Nov 02 '18 20:11 pmlopes