The README file is supposed to be the main point of introduction to any repository. Its purpose is to provide brief summary of the purpose of the project, specifications, rules, necessary resources, basic use guides, etc. Putting the README.md in your root or docs directory will automatically be recognized by GitHub and will be shown to anyone who visits the repository. For all documents, including README files, commit messages and issues, GitHub uses Markdown for formatting. If you check the resources on writing READMEs (like this one) you will see that its contents are supposed to be very similar to what we ask of you for your project proposal. It is a good practice as a collaborative developer to keep such information about your project in an easily accessible place, such as the file that will automatically be displayed for your project.
- Bonus resource: Make README
| Element | Markdown Syntax | Example | ||||||
|---|---|---|---|---|---|---|---|---|
| Heading | # H1 ## H2 ### H3 etc... |
|||||||
| Bold | **bold text** | bold text | ||||||
| Italic | *italicized text* | italics | ||||||
| Blockquote | > blockquote | blockquote |
||||||
| Ordered List | 1. First item 2. Second item 3. Third item |
|
||||||
| Unordered List | - First item - Second item - Third item |
|
||||||
| Code | `code` | code |
||||||
| Horizontal Rule | --- | |||||||
| Link | [title](https://www.example.com) | title | ||||||
| Image |  |  |
||||||
| Table | | Syntax | Description | | - | - | | Header | Title | | Paragraph | Text | |
|
||||||
| Fenced Code Block | ``` { "firstName": "John", "lastName": "Smith", "age": 25 } ``` |
 |
||||||
| Footnote | Here's a sentence with a footnote. [^1]] [^1]]: This is the footnote. |
Here's a sentence with a footnote. [1] 1. This is the footnote. |
To include the Table of Contents, you can use links:
\[link](www.example.com)
with the bulleted lists:
- \[Section 1](#section-1)
If you have VS Code, it will then automatically add all headings into the table upon saving, but you first have to make it for all sections yourself. I would advise you to make it immediately in your report (or use the one in the template report) and then it will update as you add more headings. If you want to exclude the title and table of contents as headings use the HTML heading syntax (<h1>Heading 1</h1>, <h2>Heading 2</h2>, <h3>Heading 3</h3>, ...)