Διεθνές Πανεπιστήμιο της ΕλλάδοςΤμήμα Μηχανικών Τοπογραφίας & Γεωπληροφορικής
Module 3 · 60–75 λεπτά

README και Markdown

Τεκμηρίωση του προβλήματος, των δεδομένων, της μεθόδου και των αποτελεσμάτων.

Με την ολοκλήρωση θα μπορείς

  • Να γράψεις κατανοητό README.
  • Να χρησιμοποιήσεις βασικό Markdown.
  • Να τεκμηριώσεις δεδομένα, άδειες και περιορισμούς.

Βήματα

Ξεκίνα από το πρόβλημα

Εξήγησε σε 2–3 προτάσεις τι εξετάζει το project και γιατί έχει αξία.

Περιέγραψε δεδομένα και εργαλεία

Ανάφερε πηγή, άδεια, μορφή και βασικές τεχνολογίες.

Κατέγραψε τη μεθοδολογία

Δώσε τα βασικά βήματα ώστε κάποιος να καταλάβει ή να επαναλάβει την εργασία.

Δείξε το αποτέλεσμα

Πρόσθεσε μία εικόνα, έναν χάρτη ή ένα γράφημα και εξήγησε τι δείχνει.

Πρόσθεσε περιορισμούς

Γράψε τι δεν καλύπτει η ανάλυση και τι χρειάζεται προσοχή.

Πρακτική άσκηση

Εφάρμοσέ το στο δικό σου project

Χρησιμοποίησε το README template και ολοκλήρωσε όλες τις ενότητες για το repository του module 2.

Παραδοτέο: README.md που διαβάζεται ως αυτόνομη παρουσίαση του project.