DAT290 / dokumentation / projektplan
README.md

DAT290 - Datatekniskt projekt

Välkomna till DAT290!

Ni skall i denna kurs genomföra ett projekt av större omfattning än vad ni tidigare gjort under utbildningen. Ni kommer också att vara fler som arbetar tillsammans än tidigare. Det är då viktigt att ni ser till att hålla en god struktur på de filer som ni arbetar med: koden som ni skriver, dokumentation, tester med mera. Denna struktur är viktig för er själva, men också för oss som håller i kursen, för att vi lätt skall kunna hitta och förstå ert arbete. I detta arkiv finns ett förslag på katalogstruktur som ni kan använda eller förkasta. Det viktiga är att ni hittar en struktur och håller er till den.

I detta arkiv finns också filer som ni skall använda er av i de inledande övningarna. Se till att titta igenom alla filer och skapa er en bild av vad som finns.

Om detta dokument och Markdown

Detta dokument är skrivet med markdown-syntax. Markdown är ett lättviktigt märkspråk som kan användas för att strukturera dokument, infoga länkar och tabeller med mera. Om ni använder er av Github så visas dokument med ändelsen .md som formatterade HTML-sidor; README.md i en katalog kommer dessutom alltid att visas under fillistningen. README.md är därför en användbar fil för att ge en snabb orientering om den aktuella positionen i katalogstrukturen.

Markdown är ingen standard, så olika varianter med lite olika syntax existerar. Om ni använder Github så använder de en särskild variant som är dokumenterad på deras hemsida. En snabb summering av de vanligast använda elementen kan återfinnas här.

Det är inget krav att använda sig av markdown. Det är däremot starkt rekommenderat att använda sig av README-filer som denna, skrivna med ren text eller med markdown, för att hjälpa er själva och oss som håller i kursen att navigera i kodbasen.