Πληροφορίες στο readme.md

[Lanike71]

Ας υποθέσουμε ότι κάποιος τελειώνει ένα πρότζεκτ.

Ποιές είναι οι πληροφορίες που πρέπει να έχει ένα σωστό readme.md εκτός από τις τεχνολογίες που χρησιμοποιήθηκαν;

Υπάρχει κάποιος οδηγός;

[Eranor]

Εξαρτάται το project. 

 

Εμείς χρησιμοποιούμε αυτό https://gist.github.com/PurpleBooth/109311bb0361f32d87a2

 

Έχει μέσα πως να κάνεις εγκατάσταση, docs και contributions καθώς και building/deployment process που είναι πολυ σημαντικό.

[Fortistis]

Προσωπικά δεν έχω δει ποτέ οδηγό και χρησιμοποιώ αρκετά και συχνά διάφορα πράγματα από community/github. 

Εγώ βάζω ό,τι θα χρειαστεί κάποιος για να χρησιμοποιήσει/αναπαράγει αυτό που κάνει ο κώδικας. 

[Dr.Fuzzy]

Εγώ ακολουθώ αυτό για τα δικά μου https://gist.github.com/PurpleBooth/109311bb0361f32d87a2

Άκυρο, τώρα είδα ότι το έχει κάνει post o Eranor ήδη.

Το standard είναι να ονομάζεται README.md (με κεφαλαία).

Επεξ/σία 22 Οκτωβρίου 2018 από Dr.Fuzzy

[Lanike71]

Αν είναι ο κώδικας αρκετά περίπλοκος (με την έννοια ότι πρέπει να περιγράψεις με λόγια την κάθε λειτουργία του, αλλά και χρήση) , αλλά και χωρίς λόγο για χρήση εργαλείου documentation, μπορεί να μπει στο README.md ; Ή πρέπει να μπει ως ένα καινούριο md στο github;

[Predatorkill]

5 ώρες πριν, Lanike71 είπε

Αν είναι ο κώδικας αρκετά περίπλοκος (με την έννοια ότι πρέπει να περιγράψεις με λόγια την κάθε λειτουργία του, αλλά και χρήση) , αλλά και χωρίς λόγο για χρήση εργαλείου documentation, μπορεί να μπει στο README.md ; Ή πρέπει να μπει ως ένα καινούριο md στο github;

Συνηθως στα περιπλοκα (απο οσα εχω δει τουλαχιστον) φτιαχνουν ξεχωριστο site ή git pages με το documentation. Κατα τη γνωμη μου κουραζει τα μεγαλα docs να ειναι χυμαδιο στο readme και να πρεπει να ανεβοκατεβαινεις τη σελιδα συνεχεια. 

Επισης, αν ο κωδικας «χωραει» examples βαλε οσα πιο πολλα μπορεις σε ξεχωριστα αρχεια με σχολια.

Επεξ/σία 23 Οκτωβρίου 2018 από Predatorkill