Thông tin nào nên có trong github README.md?

Thông tin nào bạn muốn thấy trong github README?

Tất cả mọi thứ nên đi trong README? I E

Giới thiệu
Cài đặt
Phiên bản
Hướng dẫn sử dụng
Thực hiện
Kiểm tra
Tài nguyên liên quan

Hoặc bạn chỉ nên đặt một số thứ nhất định trong README (Giới thiệu, Cài đặt, Phiên bản) và các thông tin khác được đặt tốt nhất trong wiki Github?

documentation github

— người dùng86834
nguồn

Tôi cũng sẽ đặt điều khoản cấp phép

— py_script

Nói một cách quá chung chung, cần có đủ thông tin để cho tôi biết dự án có hữu ích với tôi không nếu tất cả những gì tôi biết về nó là tên. Đừng giả sử bất cứ điều gì về cách người đọc tìm thấy nó.

— Keith Thompson

Câu hỏi này có một câu trả lời rất chi tiết / tốt ở đây: stackoverflow.com/questions/2304863/how-to-write-a-good-readme

— Rodrigo Graça

Tôi hy vọng sẽ thấy một giới thiệu và tổng quan ngắn gọn. Cần có một cái gì đó để thuyết phục tôi rằng dự án giải quyết một vấn đề cụ thể. Sau khi đọc README, tôi nên biết đủ thông tin để biết dự án làm gì, yêu cầu gì, xây dựng nó như thế nào và sử dụng nó như thế nào. Thông tin đó không cần phải có trong README, nhưng các liên kết đến thông tin đó nên có.

— Bryan Oakley
nguồn

+1 cho ngắn gọn. Đừng nói "README" và sau đó bỏ một đống rác mà không cần phải đọc.

— Korey Hinton