├── img
    └── screenshot.png
└── README.md


/img/screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ritaly/README-cheatsheet/HEAD/img/screenshot.png


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Project Name
 2 | > Outline a brief description of your project.
 3 | > Live demo [_here_](https://www.example.com). <!-- If you have the project hosted somewhere, include the link here. -->
 4 | 
 5 | ## Table of Contents
 6 | * [General Info](#general-information)
 7 | * [Technologies Used](#technologies-used)
 8 | * [Features](#features)
 9 | * [Screenshots](#screenshots)
10 | * [Setup](#setup)
11 | * [Usage](#usage)
12 | * [Project Status](#project-status)
13 | * [Room for Improvement](#room-for-improvement)
14 | * [Acknowledgements](#acknowledgements)
15 | * [Contact](#contact)
16 | <!-- * [License](#license) -->
17 | 
18 | 
19 | ## General Information
20 | - Provide general information about your project here.
21 | - What problem does it (intend to) solve?
22 | - What is the purpose of your project?
23 | - Why did you undertake it?
24 | <!-- You don't have to answer all the questions - just the ones relevant to your project. -->
25 | 
26 | 
27 | ## Technologies Used
28 | - Tech 1 - version 1.0
29 | - Tech 2 - version 2.0
30 | - Tech 3 - version 3.0
31 | 
32 | 
33 | ## Features
34 | List the ready features here:
35 | - Awesome feature 1
36 | - Awesome feature 2
37 | - Awesome feature 3
38 | 
39 | 
40 | ## Screenshots
41 | ![Example screenshot](./img/screenshot.png)
42 | <!-- If you have screenshots you'd like to share, include them here. -->
43 | 
44 | 
45 | ## Setup
46 | What are the project requirements/dependencies? Where are they listed? A requirements.txt or a Pipfile.lock file perhaps? Where is it located?
47 | 
48 | Proceed to describe how to install / setup one's local environment / get started with the project.
49 | 
50 | 
51 | ## Usage
52 | How does one go about using it?
53 | Provide various use cases and code examples here.
54 | 
55 | `write-your-code-here`
56 | 
57 | 
58 | ## Project Status
59 | Project is: _in progress_ / _complete_ / _no longer being worked on_. If you are no longer working on it, provide reasons why.
60 | 
61 | 
62 | ## Room for Improvement
63 | Include areas you believe need improvement / could be improved. Also add TODOs for future development.
64 | 
65 | Room for improvement:
66 | - Improvement to be done 1
67 | - Improvement to be done 2
68 | 
69 | To do:
70 | - Feature to be added 1
71 | - Feature to be added 2
72 | 
73 | 
74 | ## Acknowledgements
75 | Give credit here.
76 | - This project was inspired by...
77 | - This project was based on [this tutorial](https://www.example.com).
78 | - Many thanks to...
79 | 
80 | 
81 | ## Contact
82 | Created by [@flynerdpl](https://www.flynerd.pl/) - feel free to contact me!
83 | 
84 | 
85 | <!-- Optional -->
86 | <!-- ## License -->
87 | <!-- This project is open source and available under the [... License](). -->
88 | 
89 | <!-- You don't have to include all sections - just the one's relevant to your project -->
90 | 


--------------------------------------------------------------------------------