mirror of https://github.com/aminya/setup-cpp
62 lines
2.1 KiB
Markdown
62 lines
2.1 KiB
Markdown
|
<h1 align="center"><%= projectName %></h1>
|
||
|
|
<p>
|
||
|
|
<% if (isProjectOnNpm) { -%>
|
||
|
|
<a href="https://www.npmjs.com/package/<%= projectName %>" target="_blank">
|
||
|
|
<img alt="Version" src="https://img.shields.io/npm/v/<%= projectName %>.svg">
|
||
|
|
</a>
|
||
|
|
<% } -%>
|
||
|
|
<% if (projectVersion && !isProjectOnNpm) { -%>
|
||
|
|
<img alt="Version" src="https://img.shields.io/badge/version-<%= projectVersion %>-blue.svg?cacheSeconds=2592000" />
|
||
|
|
<% } -%>
|
||
|
|
<% if (projectPrerequisites) { -%>
|
||
|
|
<% projectPrerequisites.map(({ name, value }) => { -%>
|
||
|
|
<img src="https://img.shields.io/badge/<%= name %>-<%= encodeURIComponent(value) %>-blue.svg" />
|
||
|
|
<% }) -%>
|
||
|
|
<% } -%>
|
||
|
|
<% if (projectDocumentationUrl) { -%>
|
||
|
|
<a href="<%= projectDocumentationUrl %>" target="_blank">
|
||
|
|
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
|
||
|
|
</a>
|
||
|
|
<% } -%>
|
||
|
|
<% if (isGithubRepos) { -%>
|
||
|
|
<a href="<%= repositoryUrl %>/graphs/commit-activity" target="_blank">
|
||
|
|
<img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
|
||
|
|
</a>
|
||
|
|
<% } -%>
|
||
|
|
<% if (licenseName) { -%>
|
||
|
|
<a href="<%= licenseUrl ? licenseUrl : '#' %>" target="_blank">
|
||
|
|
<img alt="License: <%= licenseName %>" src="https://img.shields.io/<%= isGithubRepos ? `github/license/${authorGithubUsername}/${projectName}` : `badge/License-${licenseName}-yellow.svg` %>" />
|
||
|
|
</a>
|
||
|
|
<% } -%>
|
||
|
|
<% if (authorTwitterUsername) { -%>
|
||
|
|
<a href="https://twitter.com/<%= authorTwitterUsername %>" target="_blank">
|
||
|
|
<img alt="Twitter: <%= authorTwitterUsername %>" src="https://img.shields.io/twitter/follow/<%= authorTwitterUsername %>.svg?style=social" />
|
||
|
|
</a>
|
||
|
|
<% } -%>
|
||
|
|
</p>
|
||
|
|
<% if (projectDescription) { -%>
|
||
|
|
|
||
|
|
> <%= projectDescription %>
|
||
|
|
> <% } -%>
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
```sh
|
||
|
|
npm install --save <%= projectName %>
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
<!-- INSERT GENERATED DOCS START -->
|
||
|
|
|
||
|
|
<!-- INSERT GENERATED DOCS END -->
|
||
|
|
|
||
|
|
## 🤝 Contributing
|
||
|
|
|
||
|
|
You can sponsor my work here:
|
||
|
|
|
||
|
|
https://github.com/sponsors/aminya
|
||
|
|
|
||
|
|
Pull requests, issues and feature requests are welcome.
|
||
|
|
See the [Contributing guide](https://github.com/aminya/setup-cpp/blob/master/CONTRIBUTING.md).
|