At the top of the file there should be a short introduction and/ or overview that explains what the project is.
- Explanation of the application and its purpose. Answer the questions:
- What is the motivation behind the creation of the project? This should explain why the project exists.
- Why is this project relevant to the user?
- What purpose does it serve?
If relevant, provide a more detailed explanation of what the the project/app/library does.
List any requirements for using this project, like dependencies and version. Remove this section if it is not needed.
Include instructions on how to run the project on a user's local machine. Be sure to reference the technologies they might have to download for the application to run.
-
Step 1
-
Step 2
- Substep (a)
- Substep (b)
-
Step 3
Your code here
Use the below for Markdown formatting syntax:
This is a blockquote.
This is the second paragraph in the blockquote.
- list item #1
- list item #2
- ordered item #1
- ordered item #2
This is a code snippet
This is a code block
This text will be italic
This text will be bold
| First Header | Second Header |
|---|---|
| Content Cell | Content Cell |
| Content Cell | Content Cell |
To create a hyperlink to www.github.com, with a link text that says, Visit GitHub!, you'd write this in Markdown: Visit GitHub!
For example when no data are provided in the project, could be helpful to provide how the data should be structured in order to try the model. Remove this section if it is not needed.
Example JSON file
{
"user_id": 0001,
"profession": "Data Scientist"
}
Remove this section if it is not needed.
Publication
Additional link
Additional link
Include a section for credits in order to highlight and link to the authors of your project. Apart from listing contacts of specific people involved in the project, aslo include the general email to the ONS Big Data project
MIT? OGL?