This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.
This is where your any motivation description should go. Try and limit it to a paragraph or two, and maybe some discription on the objective of the project.
If any of the following are applicable to your project, then the directory structure should follow industry best practices by being named the following.
dataset/
scripts/
notebooks/
docs/
Via Package Manager Name
$ cmd to install all requirements
git clone [repo url]
if requide
Get started help and codes
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING
If you discover any security related issues, please email :author_email instead of using the issue tracker.
- [:author_name][link-author]
- [All Contributors][link-contributors]