template_README.md

Name of the project or a logo

The purpose of the project

Here you can write about what your application can do and what's its goal. For that purpose you can use bullet or numbered lists, GIFs and links.

1. Goal 1
2. Goal 2

Table of Contents

• Core features
• Installation
• Examples
• Project Structure
• Documentation
• Getting started
• License
• Acknowledgments
• Contacts
• Citation
• Examples of good README's

Core features

• Feature 1
• Feature 2
• etc.

Installation

How users can install your project.

Name of your project can be installed with pip:

pip install name

Examples

Describe examples how it should work and should be used. Images, GIFs and code cells are welcome.

Project Structure

Stable version is located ...

Repo includes:

• package 1 - explanation
• package 2 - explanation
• etc.

Documentation

Link to the documentation

Getting started

Tutorials if any

License

Link to the license

Acknowledgments

Acknowledgments

Contacts

Your contacts. For example:

• Telegram channel answering questions about your project
• VK group your VK group
• etc.

Citation

@article{"name", title = {}, author = {}, journal = {}, year = {}, issn = {}, doi = {}}

bibtex-ссылку удобно брать с google scholar

Examples of good README's

• https://github.com/pytorch/pytorch
• https://github.com/scikit-learn/scikit-learn
• https://github.com/aimclub/FEDOT