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.

Sign up for GitHub

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

Jump to bottom

create a README template #24

Open
pmlopes opened this issue Oct 10, 2018 · 3 comments
Open

create a README template #24

pmlopes opened this issue Oct 10, 2018 · 3 comments
Labels
enhancement good first issue

Comments

@pmlopes
Copy link
Owner

pmlopes commented Oct 10, 2018

Create a README template and apply the notes from #21 (comment)
@pmlopes
Copy link
Owner Author

pmlopes commented Oct 16, 2018

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 pmlopes mentioned this issue Oct 16, 2018
Closed
@slinkydeveloper
Copy link
Collaborator

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

@pmlopes
Copy link
Owner Author

pmlopes commented Nov 2, 2018

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement good first issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pmlopes @slinkydeveloper