Un readme ha de contenir els següents apartats:
- Introducció al projecte, és a dir, informació bàsica per entendre de què tracta
- Si el projecte necessita algun tipus de prerequisit
- Per a que s'utilitza el programa
- Les llicències que necessitarà el programa
- Per marcar una comanda per a executar, pots fer aixo:
sudo pkg-install guest-additionsx64.pkg
Aquesta comanda podria servir per a instal·lar les guestAddittions
- Per exemple, si volem mostrar una combinació de tecles que fa una acció en concret, podem fer aixo:
- Obrir un nou fitxer (
Ctrl+N
)
- project title: Super Mario Bros description (README.MD)
Super Mario és un videojoc de plataformes de Nintendo creat fa 36 anys que actualment és famós a tot el món
Les Característiques principals dels deus videojocs són:- Varietat d'escenaris (gran quantitat de mons)
- Una gran paleta de colors que fan que aquesta saga sigui única
- Enemics fàcils de derrotar (ja que el joc es basa en les plataformes)
- Nivells amb escenaris interactius
- Enemics finals carismàtics
- Protagonista principal considerat com heroi
- Moure't per l'escenari:
Arrows/Joystick
- Saltar
A / B
- Correr
Y / X + Arrows / Joystick
- Fer ús de l'habilitat
Y / X