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

Minimal template has link to missing "Deployment" section #35

Open
Addono opened this issue Dec 14, 2019 · 0 comments
Open

Minimal template has link to missing "Deployment" section #35

Addono opened this issue Dec 14, 2019 · 0 comments

Comments

@Addono
Copy link

Addono commented Dec 14, 2019

The minimal README.md template has a link to "Deployment" in the intro of "Getting Started". However, this section is by default not present in the template.

To me, it seems that there are two ways to address this:

  1. Rewrite the sentence in "Getting Started" and instead refer to "Usage" of the project rather than "Deployment".
  2. Add the "Deployment" section, similarly as it is present in the standard README version.

My take would be to go for (1), as it is probably more in line with the minimalistic nature of this template. However, (2) might be easier, as it requires just copy-pasting from the standard template. Another advantage of (2) would be that minimal and standard deviate as little as possible from each other, making migration between the two easier.

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