PROJECT_DESCRIPTION
This is a blank template to get started. First replace following placeholders:
- PROJECT_TITLE
- PROJECT_DESCRIPTION
- PROJECT_GITHUB_LINK
- PROJECT_WEBPAGE_URL
- PROJECT_SONARCLOUD_NAME
Assets could be placed under docs/src/assets/ folder and images should be placed in docs/src/assets/images/.
If you like to use badges, have a look at badges how to.
// this section is optional
- List of features
// this section is optional
- link
- link
- link
Instructions how to get software up and running.
List things you need to use the software and how to install them.
- npm
- Gradle
A step by step series of examples that tell you how to get it running.
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
This project is work in progress. We are working on adding more functionality, guidelines, documentation and other improvements.
Next planed features:
- feature description
See the open issues for a list of proposed improvements and known issues.
All notable changes to this project will be documented in the changelog.
We use Semantic Versioning as a guideline for our versioning.
You want to help or share a proposal? You have a specific problem? Report a bug or request a feature.
You want to fix or change code? Read the Code of Conduct and contributing guide.
See releasing.
Copyright (c) 2022 Wolf-Martell Montwé.
Please refer to the ISC License for more information.
// this section is optional
- Hat tip to anyone whose code was used
- Inspiration
- etc