-
Notifications
You must be signed in to change notification settings - Fork 1
/
README_template
60 lines (34 loc) · 2.02 KB
/
README_template
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# Project Title
Final project for the Building AI course
## Summary
Describe briefly in 2-3 sentences what your project is about. About 250 characters is a nice length!
## Problems it will solve
Which problems does your idea solve? How common or frequent is this problem? What is your personal motivation? Why is this topic important or interesting?
This is how you make a list, if you need one:
* problem 1
* problem 2
* etc.
## How is it used?
Describe the process of using the solution. In what kind situations is the solution needed (environment, time, etc.)? Who are the users, what kinds of needs should be taken into account?
Images will make your README look nice!
Once you upload an image to your repository, you can link link to it like this:
If you need to resize images, you have to use an HTML tag, like this:
<img src="https://upload.wikimedia.org/wikipedia/commons/5/5e/Sleeping_cat_on_her_back.jpg" width="300">
## Challenges
What could go wrong? Which limitations and ethical considerations should be taken into account when deploying a solution like this?
## Data sources
Where does your data come from? Do you collect it yourself or do you use data collected by someone else?
If you need to use links, here's an example:
[Twitter API](https://developer.twitter.com/en/docs)
## What next?
What kind of skills, what kind of assistance would you need to move on? How finished should the solution be in order to be good enough?
## Missing from this template
* more formatting options: code blocks
* how to add files, images, code
## Acknowledgments
* list here the sources of inspiration
* do not use code, images, data etc. from others without permission
* when you have permission to use other people's materials, always mention the original creator and the open source / Creative Commons licence they've used
For example: Sleeping Cat on Her Back by Umberto Salvagnin / [CC BY 2.0](https://creativecommons.org/licenses/by/2.0)
* etc