A fancy titled project - Project documentation

‼️ Important ‼️ This file is the documentation of your project. It should contain all requirements, crucial information and steps to reproduce your work. It may be used to evaluate your work at the final presentation, so make it understandable, easy to use and up-to-date.

‼️ Remark ‼️ Remember to make your code clean and well documented

Markdown basic syntax

Do's

1. keep your repository clean
2. document your code
3. upload just the source code
4. upload compressed images
5. instead of movies upload gifs
6. repository should be as lightweight as possible

Don'ts

1. don't upload binary and temporary files
2. don't upload unnecesary copies of your files
3. don't upload heavy files
4. don't upload configuration files of your ide

Useful examples of markdown syntax

Code

Code blocks are intended by four space or one tab. So this is a block code:

if (linkPortCore * 23) {
    clip.cc(guid, importPrinter.webmail_password_domain.usb_printer_gif(
            spool_rpc, seoTextThunderbolt), frame_cell_ole);
    tracerouteSystem += -5;
} else {
    queueDisk(ppp);
    gammaDesktopDns = mailDiskMemory;
    dragBalanceWired = quicktime_word_macro(illegal_hibernate_srgb, 962835 +
            5);
}

Tables

Tables in markdown can be made with use of hyphens (---) and pipes (|). Namely

| header1 | header2 |
| ------- | ------- |
|  elem1  | elem2 |
|  elem3  | elem4 |

generates following table

header1	header2
elem1	elem2
elem3	elem4

Images

Images can be included to the markdown page with use of the following syntax

![alternative text](path/to/the/image.png)

For example:

Other useful elements of markdown syntax

The basics of markdown syntax you will find here: markdown basic syntax.